nicht angemeldet
korrektes Kommentieren von Programmcode / Standards
0 0 
MudGuard
1 0
korrektes Kommentieren von Programmcode / Standards
hallo alle zusammen,
ich habe bei vielen Programmen oder vor einzelnen Methoden oder Funktionen(unabhängig von der verwendeten Sprache) schon vor dem eigentlich Beginn der Programmblöcke gesehen, daß man diese auf eine bestimmte Art und Weise auskommentiert.
Die Syntax dabei ist immer nach demselben Muster aufgebaut und sieht ungefähr so aus:
/**
* @author: Klaus Schaefer
* @description: BlaBlaBla
* @values: ....
*/
Kann mir jemand verraten, ob so was irgendwie standardisiert ist?
Und wenn ja, was in so einem Programmkopf stehen kann / darf und wie man das ganze nennt (solange ich das nicht weiß, kann ich nicht mal danach googlen....)?
Oder am allerbesten: Einen Link mit einer Dokumentation dazu? ;-)
Vielen Dank für eure Hilfe,
Klaus
-
Hi,
im Java-Bereich gibts das sogenannte "JavaDoc", die Tags sehen so aus, wie du es beschrieben hast, siehe http://java.sun.com. Inwieweit andere Programmiersprachen das von Haus aus unterstützen weiß ich leider nicht. Bei uns in der Firma hingegen wurde zu Projektbeginn vereinbart, dass in jedem Skript ein Kopf vereinbart ist, in dem Version, Ursprungsautor, Aktueller Stand, benutzte Tabellen/Zweck des Skriptes und Änderungsübersicht festgehalten werden. Über jeder einzelnen Funktion ist dann noch einmal ein Kopf, der die Funktion beschreibt, jeden einzelnen Parameter mit Typ sowie den Rückgabewert auflistet.
MfG
Rouven--
-------------------
ss:) zu:) ls:& fo:) de:< va:{ ch:? sh:) n4:( rl:? br:$ js:| ie:) fl:( -
Hi,
Die Syntax dabei ist immer nach demselben Muster aufgebaut und sieht ungefähr so aus:
/**
* @author: Klaus Schaefer
* @description: BlaBlaBla
* @values: ....
*/Sieht nach Javadoc aus.
Sun sollte da irgendwo Informationen zu haben ...
cu,
Andreas--
Warum nennt sich Andreas hier MudGuard?
Schreinerei Waechter
Fachfragen per E-Mail halte ich für unverschämt und werde entsprechende E-Mails nicht beantworten. Für Fachfragen ist das Forum da.
-
Hallo Klaus,
Für verschiedene Programmiersprachen ist sowas standardisiert. Wenn man Software in einer Programmiersprache entwickelt, für die es so etwas nicht gibt, ist es sicher eine gute Idee, selbst eine Richtlinie dafür zu entwerfen.
Für Java gibt es z.B. < http://java.sun.com/j2se/javadoc/writingdoccomments/index.html>
Systeme für andere Programmiersprachen funktionieren ähnlich und die meisten Richtlinien für Kommentare dürfte man übernehmen können.Grüße
Daniel
-
Hallo,
Die Syntax des Java Dokumentationsgenerators, hat sich wohl als gut erwiesen und war vielen Programmierer geläufig, so dass die Syntax auch von anderen Dokumentationsgeneratoren für andere Sprachen übernommen wurde. Für php im Bereich Objektorientierte Programmierung ist zum Beispiel http://www.phpdoc.org/ sehr interessant und äußerst nützlich.
Gruß, Arne.