Dokumentation generieren
Übersicht
BlitzMax, BlitzMax NG Beginners-Corner
|
NoaBetreff: Dokumentation generieren |
 Mi, Okt 11, 2006 12:33Antworten mit Zitat 
|
|---|---|---|
|
Hallo allerseits,
ich suche eine Möglichkeit um eine HTML-Dokumentation aus meinem Programmcode generieren zu lassen, möglichst ohne ihn irgendwie umwandeln zu müssen. Ist dies mit dem integrierten bbdoc möglich und wenn ja wie? Kennt vielleicht jemand ein Tool (möglichst mit GUI) mit dem man programmiersprachenunabhängig Dokumentationen generieren lassen kann ohne all zu großen Aufwand? Danke im Voraus für die Antworten |
||
Dreamora |
Mi, Okt 11, 2006 14:09 Antworten mit Zitat
|
|
|---|---|---|
|
Ja zur ersten und Nein zur zweiten Frage
BBDoc erzeugt nur aus Modulen eine Dokumentation und auch das nur wenn sie entsprechend formatiert ist.(da geben die BRL Module einen Ansatz um zu sehen wie es geht. Werden ohnehin nur wenige Möglichkeiten gegeben) Auch ansonsten kenne ich für BM nur Moduldocumenter (HotDocs zb). Programmiersprachenunabhängig ist prinzipiell nicht möglich, da der Parser schliesslich wissen muss an welchen Punkten er überhaupt nach einer Dokumentation suchen muss und wozu diese dann gehört und das hängt vom Syntax ab. |
||
| Ihr findet die aktuellen Projekte unter Gayasoft und könnt mich unter @gayasoft auf Twitter erreichen. | ||
Barbapapa |
Do, Okt 12, 2006 20:02 Antworten mit Zitat
|
|
|---|---|---|
|
Nur so 'ne Idee, vielleicht könntest du die Max-Kommentar-Syntax kurz vor der Generierung soweit automatisch abändern lassen, dass du mit Javadoc die Doku generieren lassen kannst.
Quasi von Rem End Rem in /** */ Innerhalb dessen sind noch viele Parameter möglich, schau dich mal bei Sun um.. |
||
Dreamora |
Do, Okt 12, 2006 22:26 Antworten mit Zitat
|
|
|---|---|---|
|
Und was bringt das?
JavaDoc schaut doch auch auf den Java Syntax um die /** **/ blöcke und die zugehörige funktionalität zu verbinden, nicht? Und Function xy:int() ist und wird nie eine java anweisung sein ^^ Da ist es um einiges einfacher selbst ein Dokumentierungsprogramm zu schreiben ... |
||
| Ihr findet die aktuellen Projekte unter Gayasoft und könnt mich unter @gayasoft auf Twitter erreichen. | ||
Barbapapa |
Do, Okt 12, 2006 23:08 Antworten mit Zitat
|
|
|---|---|---|
|
hmmmm, nicht, Javadoc ist der Quellcode wurscht, es schaut nur was zwischen /** und */ steht. Dort kann man zig Parameter angeben, die OOP-Spezifisch und auch generell sind. such such such.. da
http://de.wikipedia.org/wiki/Javadoc da isses schöner erklärt. Edit: Oder das da.. http://www.stack.nl/~dimitri/doxygen/index.html |
||
Dreamora |
Fr, Okt 13, 2006 7:28 Antworten mit Zitat
|
|
|---|---|---|
|
Und hast du auch gelesen, was da steht?
Zitat: Javadoc parst die Quelltexte nach allen Javadoc-Kommentaren (beginnend mit /**) und den darauf folgenden, nicht-lokalen Symbolen
Will heissen: Kein Java Source -> keine nicht-lokalen Symbole -> kein Java Doc |
||
| Ihr findet die aktuellen Projekte unter Gayasoft und könnt mich unter @gayasoft auf Twitter erreichen. | ||
Barbapapa |
Fr, Okt 13, 2006 10:25 Antworten mit Zitat
|
|
|---|---|---|
| naja, genau! und deswegen rem und End rem VOR Doku-Generierung ersetzen lassen durch /** und */. Könnte man alles in einer Bat automatisiert durchführen lassen. | ||
|
Goodjee |
Fr, Okt 13, 2006 11:45 Antworten mit Zitat
|
|---|---|---|
| ich würde ir das selber schreiben, alle funktionen suchen, auflisten, und die kommentare die hinter dem namen stehen der funktion zuordnen, außerdem kommentare am anfang und am ende übernehmen... | ||
|
"Ideen sind keine Coladosen, man kann sie nicht recyclen"-Dr. House
http://deeebian.redio.de/ http://goodjee.redio.de/ |
||
Übersicht
BlitzMax, BlitzMax NG Beginners-Corner
Powered by phpBB © 2001 - 2006, phpBB Group