Tool zum Kommentieren

Reply to Tool zum Kommentieren on Wed, 13 Aug 2008 16:24:28 GMT

Matrim — Wed, 13 Aug 2008 16:24:28 GMT

Hallo,

gibt es soetwas wie ein Tool, mit dem man Quellcode gut und einfach kommentieren kann?

Soetwas in der Art, wie dass es alle Funktionen auflistet und Kommentare dazu sammeln, auch über deren Parameter usw?

Danke für einen Tipp im Voraus.

Mat.

Reply to Tool zum Kommentieren on Wed, 13 Aug 2008 16:29:38 GMT

Berufspenner — Wed, 13 Aug 2008 16:29:38 GMT

Ich glaube kaum, dass es soetwas gibt, denn dafür müsste das Programm ganz schön intelligent sein, um deinen Code verstehen und beschreiben zu können

Reply to Tool zum Kommentieren on Wed, 13 Aug 2008 16:34:42 GMT

Matrim — Wed, 13 Aug 2008 16:34:42 GMT

Ich meinte natürlich nicht, dass es die Kommentare inhaltlich setzt, sondern viel eher dann im Dialogsystem von mir die entsprechenden Eingaben erwartet.

Reply to Tool zum Kommentieren on Wed, 13 Aug 2008 16:46:20 GMT

Nexus — Wed, 13 Aug 2008 16:46:20 GMT

MSVC++ hat zum Beispiel das IntelliSense-System, das z.B. Member von Klassen oder Namespaces schön auflisten kann. Wenn man dazu einen Kommentar schreibt, sieht man ihn bei der Liste auch gleich. Ausserdem gibts einen Klassenbrowser, wo man alle globalen Funktionen und Variablen, Makros, Klassen schön dargestellt hat.

Edit: Hab grad gemerkt, dass das wahrscheinlich nicht das ist, was du suchst...

Reply to Tool zum Kommentieren on Wed, 13 Aug 2008 16:43:04 GMT

asc — Wed, 13 Aug 2008 16:43:04 GMT

Matrim schrieb:

gibt es soetwas wie ein Tool, mit dem man Quellcode gut und einfach kommentieren kann?

Wenn du dokumentieren und Kommentare auswerten meinst, ja (z.B. doxygen).
Ein Tool was aber durchläuft und Kommentare hinzufügt (ob nun mit Rückfrage oder Ohne) ist mir völlig unbekannt.

doxygen hat aber soweit ich mich erinnere, auch eine Einstellung mit der das Fehlen von Kommentaren bei der Ausgabe angemeckert wird...

Reply to Tool zum Kommentieren on Thu, 14 Aug 2008 07:10:12 GMT

berniebutt — Thu, 14 Aug 2008 07:10:12 GMT

Mit etwas Aufwand und einem sauberen Programmentwurf kannst Du das schon machen. Dafür richtest Du eine Kommentardatei 'TEST.TXT' ein, in die Du für jede Funktion den Einstieg mitsamt den Inputgrössen, die Zwischenergebnisse und den Ausstieg mitsamt den Outputgrössen dokumentierst. Über einen (oder mehrere) globale Schalter (bool) steuerst Du, ob etwas dokumentiert werden soll oder nicht. Gewöhnlich macht man das aber durch 'Auskommentieren'. Jetzt willst Du aber noch menr, nämlich eine Auswertung der dokumentierten Einträge. Das geht wohl nur über ein zusätzliches Programm, das die Kommentardatei nachträglich analysiert. Ein fertiges Tool dafür zu suchen, dürfte vergeblich bleiben. So etwas selbst zu zu schreiben lohnt meiner Meinung nach auch nicht.
Investiere Deine Mühen besser in das Design Deiner Programme.

Reply to Tool zum Kommentieren on Thu, 14 Aug 2008 07:48:56 GMT

Matrim — Thu, 14 Aug 2008 07:48:56 GMT

Danke für die Antworten.

Unter Jave, mit Eclipse, gibt es zumindest etwas, wo man Kommentare Templates einstellen kann. Leider hatte ich unter CDC soetwas noch nicht gefunden.

Danke soweit.