Difference between revisions of "Phobos coding conventions"
Monarchdodra (talk | contribs) |
(Removed incorrect item.) |
||
| Line 4: | Line 4: | ||
** Avoid using the tab character. | ** Avoid using the tab character. | ||
** Use 4-space indentation. | ** Use 4-space indentation. | ||
| − | |||
** For blocks enclosed by curly braces ({{code|{{()}}}}), the opening and closing braces should be on their own lines, at the same indentation level as its containing block: | ** For blocks enclosed by curly braces ({{code|{{()}}}}), the opening and closing braces should be on their own lines, at the same indentation level as its containing block: | ||
<syntaxhighlight lang="d"> | <syntaxhighlight lang="d"> | ||
| Line 22: | Line 21: | ||
* Naming | * Naming | ||
** Identifiers should use camelcase instead of underscores: {{code|myVariable}} instead of {{code|my_variable}}. | ** Identifiers should use camelcase instead of underscores: {{code|myVariable}} instead of {{code|my_variable}}. | ||
| − | ** Types (or templates returning types) should use | + | ** Types (or templates returning types) should use PascalCase: {{code|ElementType}} instead of {{code|elementType}} or {{code|element_type}}. |
* Length of lines: | * Length of lines: | ||
Revision as of 05:47, 23 December 2012
If you're planning to submit pull requests for druntime or Phobos, you should follow the following coding conventions:
- Style
- Avoid using the tab character.
- Use 4-space indentation.
- For blocks enclosed by curly braces ({}), the opening and closing braces should be on their own lines, at the same indentation level as its containing block:
void main(string[] args)
{
if (args.length == 0)
{
writeln("Please specify filename");
}
else
{
lotsOfDotDotDotMagic(args);
}
}
- Naming
- Identifiers should use camelcase instead of underscores: myVariable instead of my_variable.
- Types (or templates returning types) should use PascalCase: ElementType instead of elementType or element_type.
- Length of lines:
- Lines should preferably not be longer than 80 characters, though this is a soft limit.
- Documentation should never be longer than 80 characters. This is a hard limit.
Note that this are the guidelines. In general, just like in any collaborative project, try your best to conform to the same coding style as in the rest of the source file you're editing.
