Dragora GNU/Linux-Libre

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview

Artifact ID: e30a2657946317ef44df47a1e7e1733ead9a47bc
Page Name:Style
Date: 2016-04-08 14:19:01
Original User: selk
Mimetype:text/x-markdown
Parent: 64093b5b2afe4b7bce22240bc776a9c6b797ee8c
Content

Style guidelines

Dragora source code should following the style guidelines below.

General points:

Comments contain no spelling or grammatical errors. (Abbreviations and sentence fragments are acceptable when trying to fit a comment on a single line as long as the meaning is clear.)

The tone of comments is professional and courteous. Comments contain no profanity, obscenity, or innuendo.

All comments and identifiers are in English.

Functions:

Unless the function is obvious enough use a brief header comment describing its use and implementation.

The name of a function clearly reflects its purpose.

Variables:

When a variable that refers to the same value is used within multiple scopes, the same name is used in all cases.

When variables refer to different values, different names are used even when the names are in different scopes.

Finally, when in doubt look at code already written.