1,554
edits
Difference between revisions of "Code Formatting Conventions"
Code Formatting Conventions (view source)
Revision as of 16:17, 18 April 2021
, 16:17, 18 April 2021→Special Keywords: added I18N
(→Vertical space: -- new section) |
(→Special Keywords: added I18N) |
||
| Line 311: | Line 311: | ||
* '''TODO''' marks incomplete code, or things that could be done better but are left for the future. | * '''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! | * '''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! | ||
* '''I18N:''' Adds comment to translators for internationalization. See [[Supporting GUI Translation]]. | |||
=== Doxygen documentation comments === | === Doxygen documentation comments === | ||