Zu einem guten Codierstyleguide gehört immer auch eine Formatierungsansage. Es ist deutlich einfacher, fremde Quelltexte zu lesen, wenn diese gleichförmig formatiert sind. Unschön formatierte Sourcecodes gibt es zuhauf. Auch man selber ist nicht immer gefeit, die eigenen Stilvorgaben und Vorlieben auch einzuhalten. Auch wenn man in einem Team gemeinsam Sourcen bearbeitet, kann ein solcher Styleguide helfen. Beim Hatari Projekt ist das z.B. recht uneinheitlich.
Wie genau ein Quellcode nun einzurücken und zu formatieren ist, das bleibt immer eine persönliche Frage, z.B. wie geschweifte Klammern zu setzen sind. Hauptsache, der Stil ist einheitlich.
Dabei helfen natürlich kleine Tools, bessere IDEs wie Code::Blocks oder Eclipse bieten gleich entsprechende Plugins. Häufig rufen diese aber auch nur fertige Tools für die Kommandozeile auf.
Unter Linux kommen direkt 2 Kandidaten infrage:
- GNU Indent (http://www.gnu.org/software/indent/)
- Artistic Style (http://astyle.sourceforge.net)
Ich habe mich für Artistic Style entschieden, da es die von mir genutzten Optionen auf Anhieb anbietet. Ich habe nur ein wenig experimentiert und meine Vorlieben sehen wie folgt aus:
#
# astylerc for Matthias Arndt
#
# history:
# 2011-05-26 initial version
#
# main style:
style=bsd
# indentation with TABS (4 spaces per TAB):
indent=tab
# contents of switch case statements are indented, including the break:
indent-cases
# preprocessor statements that are split are indented:
indent-preprocessor
# loops and if statements are seperated by empty lines:
# (associated block comments are kept)
break-blocks
# parenthesis are padded with spaces:
pad-paren
# unnecessary empty lines are deleted:
delete-empty-lines
Das Ganze kann man nach $HOME/.astylerc speichern und schon braucht man das Tool nicht mehr mit Kommandozeilenparametern zu füttern.