Difference between revisions of "Phobos coding conventions"

From D Wiki
Jump to: navigation, search
(Removed incorrect item.)
(There is no need for this page. It attempts to duplicate official documentation.)
Line 1: Line 1:
If you're planning to submit [[Pull Requests|pull requests]] for druntime or Phobos, you should follow the following coding conventions:
+
See http://dlang.org/dstyle.html
 
 
* Style
 
** Avoid using the tab character.
 
** 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:
 
<syntaxhighlight lang="d">
 
void main(string[] args)
 
{
 
    if (args.length == 0)
 
    {
 
        writeln("Please specify filename");
 
    }
 
    else
 
    {
 
        lotsOfDotDotDotMagic(args);
 
    }
 
}
 
</syntaxhighlight>
 
 
 
* Naming
 
** Identifiers should use camelcase instead of underscores: {{code|myVariable}} instead of {{code|my_variable}}.
 
** Types (or templates returning types) should use PascalCase: {{code|ElementType}} instead of {{code|elementType}} or {{code|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.
 

Revision as of 23:09, 23 December 2012