1,079
edits
Difference between revisions of "Code Formatting Conventions"
no edit summary
(substitute tabs with 4 spaces for visual consitency) |
|||
| Line 133: | Line 133: | ||
void thisIsMyFancyMethod(); | void thisIsMyFancyMethod(); | ||
</pre> | </pre> | ||
== 7. Special comments == | |||
The following goes slightly beyond code formatting: We use certain keywords (together with an explanatory text) to mark certains sections of our code. In particular: | |||
* FIXME marks code that contains hacks or bad temporary workarounds, things that really should be revised at a later point. | |||
* TODO marks incomplete code, or things that could be done better but are left for the future. | |||
* WORKAROUND marks code that works around bugs in the original game, like script bugs. Sometimes these bugs worked in the original due to bugs in the original engine, sometimes the bug was visible in the original, too. It's important that you explain here what exactly you work around, and if applicable, refer to relevant tracker items! | |||