Coding Style Guidelines

LaTeX

Indentation

Every block should be indented one tab more then the containing block.

Commenting/TODO

Use the \todo{arbitrary text} command to write TODOs into documents.

Acronyms

Abbreviations and shortcuts should be enclosed with \ac{*}.
If no command of the acronym-package is used in the text, then this shortcut will not be displayed in the table of acronyms.
Acronyms that aren't in the table should be added with: \acro{"Shortcut"}{"Explanation"}.

Example:

1. Entry in "Table": \acro{FPGA}{Field Programmable Gate Array}
2. Usage in the Text: \ac{FPGA}

#Java ##Variable names

• camelCase
• declarative naming