Language¶

Basic language within the OurPlant OS source code is English. Documentation has to be written in German or English.

This rule concerns the following items - [this guide] - commits - comments within code - filenames - folders - variables, methods, classes, units - public issues (confidential/privat issues can be written in German)

Identifiers that could not be translated in common English, the German identifier name is suitable as well. Good practice: Find a different descripion in english.

Example:

// ...

  /// <remarks>

  /// 3D Bestückkopf

  /// </remarks>

// ...

function TForm1.GetPlacerName: string;

begin

  Result := fPlacerName;

end.