25.8 Sourcecode Beautifier
Ein Quellcode-Verschönerer hat die Aufgabe, Quellcode unter Beibehaltung der logischen Struktur lesbarer und damit wartungsfreundlicher zu machen. Die Funktionen, die ein Beautifier anbietet, sind beispielsweise:
|
Intelligente Einrückung des Quellcodes mit Tabulatoren oder Leerzeichen und Absatzende-Zeichen |
|
|
Konsistentes Behandeln der geschweiften Klammern. Unterschiedliche Schulen propagieren sehr unterschiedliche Auffassungen, wie die geschweiften Klammern im Quelltext gesetzt werden sollen. |
|
|
Formatieren der Kommentare in einem einheitlichen Format |
|
|
Automatisches Generieren der JavaDoc-Anweisungen. Das, was aus dem Quelltext hervorgeht, lässt sich automatisch in einen Dokumentationskommentar übersetzen. |
|
|
Einfügen von Kopf- und Fußzeilen-Vorlagen (Templates) |
|
|
Verarbeitungen im Batch-Prozess |
|
|
Einige Produkte bieten ebenfalls eine offene API an, so dass das Produkt als Bibliothek von eigenen Programmen genutzt werden kann. Das ist nützlich für Programme, die Java-Quellcode generieren, wie Parser-Generatoren oder die UML nach Java-Programmen. Die Software kann dann entlastet werden und muss sich nicht um die Einrückung |
|
|
des erzeugten Quellcodes kümmern. |
Hier klicken, um das Bild zu Vergrößern
Einige Programme schicken sich nun an, diese Anforderungen zu erfüllen. Viele Dienstprogramme sind im Quellcode verfügbar. Die folgende Liste zählt einige Produkte auf:
|
|
Jindent unter http://www.jindent.com/ ist ein kommerzielles Produkt, das aber auch in einer freien Variante angeboten wird. Das Produkt ist sehr professionell und erlaubt eine sehr feine Einstellung der Ausgabe über Konfigurationsdateien. Daneben kann das Programm auch den Quellcode für Web-Seiten oder Präsentationen aufbereiten. |
|
