development:editor-gtk:code-formatting-conventions
Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
development:editor-gtk:code-formatting-conventions [2014/07/02 17:48] – created fdelapena | development:editor-gtk:code-formatting-conventions [2019/08/15 00:52] (current) – removed fdelapena | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Editor-GTK code formatting conventions ====== | ||
- | Editor-GTK conventions are like player conventions, | ||
- | |||
- | ====Naming==== | ||
- | ---- | ||
- | ==Constants== | ||
- | All upper case, with underscores as name separators, but no leading/ | ||
- | <code csharp> | ||
- | |||
- | ==Type names== | ||
- | Clases should be UpperCamelCase. | ||
- | <code csharp> | ||
- | class Armor : Item {</ | ||
- | |||
- | ==Functions== | ||
- | Functions should be lower case with underscores as word separators. | ||
- | <code csharp> | ||
- | Properties should have getter and setter defined: | ||
- | <code csharp> | ||
- | private int random_int { public get; private set; } | ||
- | public bool has_something { public get; public set; } | ||
- | }</ | ||
- | |||
- | ==Variables== | ||
- | Variables should be lower case with underscores as word separators. | ||
- | <code csharp> | ||
- | |||
- | ====Comments==== | ||
- | Use /* This style */ preferably. | ||
- | |||
- | Please use Valadoc comment style (Javadoc like) for code documentation. | ||
- | |||
- | ==License File Header== | ||
- | Remember to copy (from any other existing file) the license header to all new created files. | ||
- | |||
- | ==Special comments== | ||
- | <code csharp>// | ||
- | // FIXME: what code and in what circumstances it does not work, and if possible why it does not work well</ |
development/editor-gtk/code-formatting-conventions.1404323295.txt.gz · Last modified: 2014/07/02 17:48 by fdelapena