| | 34 | |
| | 35 | |
| | 36 | == Coding Style == |
| | 37 | |
| | 38 | It is very important for a template to be well presented so that others can understand it and contribute to it. QWG templates are designed to allow many people to contribute to the standard set of templates. There is not a very strict coding style but a few recommandations: |
| | 39 | 1. If you contribute to an existing template, except if the template doesn't adhere to a minimum standard of readability, try to adhere to the convention used in the initial template. |
| | 40 | 1. Use spaces rather than tabs as tabs are not displayed the same way in all editors. Use the same tab identation that is already used in an existing template. Else the typical recommendation is 2 spaces. |
| | 41 | 1. Ident properly list and nlist, with one element per line, each line (including the last one) followed by a `,`. |
| | 42 | 1. Prefer meaningful variable names to long comments |
| | 43 | 1. Write the minimum set of comments required for others to understand your implementation when there is some hidden complexity or an external constraint like a bug. In case something is a workaround for a bug, please put a reference to the bug if available in a publically available bug tracker. |
