Files |  Tutorials |  Articles |  Links |  Home |  Team |  Forum |  Wiki |  Impressum

Aktuelle Zeit: Mi Okt 21, 2020 16:33

Foren-Übersicht » DGL » Umfragen
Unbeantwortete Themen | Aktive Themen



Ein neues Thema erstellen Auf das Thema antworten  [ 24 Beiträge ]  Gehe zu Seite Vorherige  1, 2

Wie dokumentiert ihr euren Code?
Mit einem externen Schreibprogramm. (Word) 2%  2%  [ 1 ]
Ich lass es aus dem Code generieren. (Doxygen, Javadoc) 14%  14%  [ 8 ]
Ich hab im Code große Dokupassagen. 7%  7%  [ 4 ]
Bei den interessanten Stellen stehen 1-2 Zeilen im Code. 70%  70%  [ 39 ]
Mir war gar nicht klar das Doku wichtig sein könnte. 4%  4%  [ 2 ]
Doku is was für Anfänger. Ich hab das alles im Kopf. 4%  4%  [ 2 ]
Abstimmungen insgesamt : 56
Autor Nachricht
 Betreff des Beitrags:
BeitragVerfasst: Do Mär 15, 2007 12:13 
Offline
Ernährungsberater
Benutzeravatar

Registriert: Sa Jan 01, 2005 17:11
Beiträge: 2023
Programmiersprache: C++
Traude hat geschrieben:
I0n0s schrieb:
Zitat:
Für Delphi gibt es auch PasDoc :wink:


Oje, das kommt auch noch auf mich zu. :( Hab ich mir bisher auch nur aus der Entfernung angesehen.

Och, so schwer ist es nicht, wobei ich bei der GUI eh sagen würde, dass es euch nicht bringt. Ihr habt ja eh ein Designdokument, und wenn man dann eine "richtige" Doku aus dem Quelltext erstellt ohne Hilfen wie Pasdoc könne man vielleicht nochmal Fehler im Design finden?

_________________
Steppity,steppity,step,step,step! :twisted:
❆ ❄ ❄ ❄ ❅ ❄ ❆ ❄ ❅ ❄ ❅ ❄ ❅ ❄ ❄
❄ ❄ ❄ ❅ ❄ ❄ ❄ ❅ ❄ ❄ ❆ ❄ ❄


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags:
BeitragVerfasst: Do Mär 15, 2007 12:37 
Offline
DGL Member
Benutzeravatar

Registriert: Di Okt 03, 2006 14:07
Beiträge: 1277
Wohnort: Wien
Wenn man Fehler im Design findet, muss man diese beseitigen, ganz klar. Laufe ich Dir jetzt ins offene Messer hm? :wink:

Aber im Ernst: das ist zwar off Topic hier, aber ausdiskutieren sollte man das, wo auch immer Du willst.


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags:
BeitragVerfasst: Do Mär 15, 2007 14:38 
Offline
DGL Member
Benutzeravatar

Registriert: Di Mai 18, 2004 16:45
Beiträge: 2576
Wohnort: Berlin
Programmiersprache: C/C++, C#
Ich bin in der Regel sehr Kommentarfaul aber ich arbeite dran. Ich hab die Tage für Pasdoc ein XML generator geschrieben, so kann man nun --format html,latex,Windows Hilfe und xml angeben. Ein php script erlaubt dann, das lesen der xml datein und kann somit in eigene Webseiten,CMS oder WIKI eingepflegt werden.

_________________
"Wer die Freiheit aufgibt um Sicherheit zu gewinnen, der wird am Ende beides verlieren"
Benjamin Franklin

Projekte: https://github.com/tak2004


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags:
BeitragVerfasst: Do Mär 15, 2007 14:48 
Offline
DGL Member
Benutzeravatar

Registriert: Di Dez 27, 2005 12:44
Beiträge: 393
Wohnort: Berlin
Programmiersprache: Java, C++, Groovy
Hallo,

ich kommentier ziemlich knapp und nur wenn es wirklich notwendig ist.
Meine Devise ist lieber keine, als falsche oder verwirrende Kommentare zu setzen.

Man muss auch bedenken, dass man bei Änderungen am Quellcode nicht vergessen darf, seine Kommentierung aktuell zu halten (das vergessen einige), z.B. wenn sich Parameter in einer Funktion ändern oder ähnliches.

Viele Grüße
dj3hut1


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags:
BeitragVerfasst: Do Mär 15, 2007 17:50 
Offline
DGL Member
Benutzeravatar

Registriert: Di Sep 03, 2002 15:08
Beiträge: 662
Wohnort: Hamburg
Programmiersprache: Java, C# (,PhP)
Wieso aktuell halten? Mehr als was die besagte Funktion machen soll steht doch eh selten bei, oder wer schreibt da einen ganzen Roman hin?

_________________
(\__/)
(='.'=)
(")_(")


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags:
BeitragVerfasst: Fr Mär 16, 2007 12:30 
Offline
DGL Member

Registriert: Di Jan 30, 2007 14:44
Beiträge: 14
Traude hat geschrieben:
1. Jedwede Doku hat in Englisch zu erfolgen (nicht weil ich das Zeug verkaufe, sondern um mich ein wenig zu üben)


das ist mehr als sinnvoll, nachdem ich schwedischen und spanischen quellcode verarbeiten durfte merkt man, wie sinnvoll das ist, wenn eine gemeinsame verständigungsbasis besteht - auch bei Methoden- und Elementnamen.

Leider halt ich mich da selbst nicht immer dran, vorallem neig ich bei langen ausdrücken die abzukürzen, damit der quelltext sich nicht so schrecklich aufbläht - vorallem, wenn man längere ausdrücke mit nem dutzend variablen drin hat.
dann empfiehlt es sich aber eh den ausdruck aufzutrennen. wenn man es ordentlich macht wird der code dadurch nicht langsamer und debuggen lässt er sich auch einfacher.

aber wer kennt nicht den unterschied zwischen vorsatz und realität - vorallem wenn der chef meint, dass das quick&dirty-demo-programm ja seine aufgabe erfüllt und man jetzt was anderes tun könne :D


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags:
BeitragVerfasst: Fr Mär 16, 2007 14:38 
Offline
DGL Member
Benutzeravatar

Registriert: Di Dez 27, 2005 12:44
Beiträge: 393
Wohnort: Berlin
Programmiersprache: Java, C++, Groovy
@Evil-Devil

Bei (guten) Javadoc-Kommentaren z.B. sollte man zusätzlich zur Beschreibung für jede Funktion Eingabe- und Ausgabeparameter beschreiben, dass sieht dann ungefähr so http://java.sun.com/j2se/1.5.0/docs/api/javax/swing/JScrollPane.html#JScrollPane(java.awt.Component,%20int,%20int) aus.

Vor allem, wenn man eine API schreibt, die auch andere benutzen sollen, sollte eine Kommentierung natürlich so gut wie möglich sein.
Bei eigenen Projekten mach ich das allerdings (wahrscheinlich aus Faulheit :P) eher selten so umfangreich.

Viele Grüße
dj3hut1


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags:
BeitragVerfasst: Fr Mär 16, 2007 16:01 
Offline
DGL Member
Benutzeravatar

Registriert: Di Sep 03, 2002 15:08
Beiträge: 662
Wohnort: Hamburg
Programmiersprache: Java, C# (,PhP)
Du weisst das man für die Parameter, sofern sie aus dem JDK oder jedweder anderen Doku die Verlinkung nicht selbst vornehmen muss? Man muss sie lediglich beim Build referenzieren und JavaDoc macht den Rest.

Und die Ein/Ausgabe Parameter lassen sich sehr gut via @param name beschreibung setzen ;)

_________________
(\__/)
(='.'=)
(")_(")


Nach oben
 Profil  
Mit Zitat antworten  
 Betreff des Beitrags:
BeitragVerfasst: Do Apr 19, 2007 18:06 
Offline
DGL Member
Benutzeravatar

Registriert: Do Sep 02, 2004 19:42
Beiträge: 4158
Programmiersprache: FreePascal, C++
Also, normalerweise schreibe ich nur an wirklich wichtigen Stellen Kommentare. Meine Variablen-, Prozeduren-, Funktionen- und Methodennamen wähle ich immer so, dass ich sie später wiedererkenne (Was heißt, Zählvariablen sind immer I, I1, I2... :wink: Aber sonst ist alles gründlich benannt). Dafür habe ich mir das Was-Würde-Jemand-Bei-Diesem-Namen-Denken-Wenn-Er-Das-Projekt-Nur-Im-Groben-Umriss-Kennt-Denken angewöhnt. Das kann durchaus hilfreich sein, seit dem verstehe ich meinen Code, selbst wenn ich ihn Wochenlang liegengelassen habe und mich mit PHP oder sonstwas beschäftigt habe.

Vor kurzem habe ich einen bereich im Code genauer dokumentiert um an den Fehler zu kommen, weil ich beim Kommentieren nochmals überdenke, was die einzelnen Calls eigentlich machen. Das hat mir letzlich auch geholfen (habe anstatt auf den Parameter auf das Result zugegriffen, wobei beide vom gleichen Typ waren...)

Gruß Lord Horazont

_________________
If you find any deadlinks, please send me a notification – Wenn du tote Links findest, sende mir eine Benachrichtigung.
current projects: ManiacLab; aioxmpp
zombofant networkmy photostream
„Writing code is like writing poetry“ - source unknown


„Give a man a fish, and you feed him for a day. Teach a man to fish and you feed him for a lifetime. “ ~ A Chinese Proverb


Nach oben
 Profil  
Mit Zitat antworten  
Beiträge der letzten Zeit anzeigen:  Sortiere nach  
Ein neues Thema erstellen Auf das Thema antworten  [ 24 Beiträge ]  Gehe zu Seite Vorherige  1, 2
Foren-Übersicht » DGL » Umfragen


Wer ist online?

Mitglieder in diesem Forum: 0 Mitglieder und 1 Gast


Du darfst keine neuen Themen in diesem Forum erstellen.
Du darfst keine Antworten zu Themen in diesem Forum erstellen.
Du darfst deine Beiträge in diesem Forum nicht ändern.
Du darfst deine Beiträge in diesem Forum nicht löschen.
Du darfst keine Dateianhänge in diesem Forum erstellen.

Suche nach:
Gehe zu:  
cron
  Powered by phpBB® Forum Software © phpBB Group
Deutsche Übersetzung durch phpBB.de
[ Time : 0.051s | 16 Queries | GZIP : On ]