Kabelsalat
2006-05-27, 22:58:28
... ich bin gerade auf zwei interessante Tools für Javascript-Entwickler gestoßen. Das zweite ist mehr etwas für .Net-Entwickler, das erste wird jedoch für jeden interessant sein.
ScriptDoc [1]: Vielleicht sind euch XML-Code-Dokumentationskommentare bereits ein Begriff. Generell geht es darum, Code zu beschreiben und diese Beschreibung so zu gestalten, dass sie zu XML-Dokumentationsdateien verarbeitet werden können. Tools wie NDoc bieten dann die Möglichkeit diese Dokumentationsdateien zu einer "richtigen" Dokumentation aufzuwerten. Ich selber habe diese Kommentare bisher nicht nur für .net-Code verwendet, sondern auch Javascript-Projekte auf diese Weise dokumentiert, wobei ich jedoch noch kein Tool für die Auswertung dieser Kommentare in Javascript-Dateien gekannt habe - soeben bin ich auf ein solches gestoßen: ScriptDoc. Das Tool geht zwar anscheinend nicht davon aus, dass sich die Kommentare vor der Deklaration befinden (wie z.B. in C# und Vb.Net üblich), da die Quellen offen sind, sollte sich aber auch das ändern lassen.
Script# [2]: Einer Scriptsprache wie JS fehlt im Vergleich zu einer richtigen Programmiersprache so einiges. Das Spektrum reicht von klaren OOP-Prinzipien (OOP ist dennoch in gewissen Umfang möglich) über den nicht vorhandenen Compiler (um Code im Vorfeld zu überprüfen), zu vielen weiteren kleineren und größeren Aspekten. Dem hat sich Nikhil Kothari angenommen, in dem er dem Entwickler die Möglichkeit bietet C#-Code zu schreiben, der schlussendlich in Javascript übersetzt wird. Welche Vorteile dieser Ansatz bieten kann, erfahrt ihr in seinem Blog [2].
Ich selber habe die Tools bisher noch nicht ausprobiert, von den Dokumentationskommentaren habe ich jedoch bereits ausgiebig Gebrauch gemacht (wenngleich im Bereich JS bisher ohne Möglichkeit der Auswertung) und kann jedem nur raten ebenfalls auf vergleichbare Arten der Dokumentation zu setzen. Auch Script# stellt einen sehr interessanten Ansatz dar...
... Viel Spaß beim ausprobieren
Kabelsalat
Die Links:
[1] http://weblogs.asp.net/bleroy/archive/2006/05/01/444739.aspx
[2] http://www.nikhilk.net/ScriptSharpIntro.aspx
ScriptDoc [1]: Vielleicht sind euch XML-Code-Dokumentationskommentare bereits ein Begriff. Generell geht es darum, Code zu beschreiben und diese Beschreibung so zu gestalten, dass sie zu XML-Dokumentationsdateien verarbeitet werden können. Tools wie NDoc bieten dann die Möglichkeit diese Dokumentationsdateien zu einer "richtigen" Dokumentation aufzuwerten. Ich selber habe diese Kommentare bisher nicht nur für .net-Code verwendet, sondern auch Javascript-Projekte auf diese Weise dokumentiert, wobei ich jedoch noch kein Tool für die Auswertung dieser Kommentare in Javascript-Dateien gekannt habe - soeben bin ich auf ein solches gestoßen: ScriptDoc. Das Tool geht zwar anscheinend nicht davon aus, dass sich die Kommentare vor der Deklaration befinden (wie z.B. in C# und Vb.Net üblich), da die Quellen offen sind, sollte sich aber auch das ändern lassen.
Script# [2]: Einer Scriptsprache wie JS fehlt im Vergleich zu einer richtigen Programmiersprache so einiges. Das Spektrum reicht von klaren OOP-Prinzipien (OOP ist dennoch in gewissen Umfang möglich) über den nicht vorhandenen Compiler (um Code im Vorfeld zu überprüfen), zu vielen weiteren kleineren und größeren Aspekten. Dem hat sich Nikhil Kothari angenommen, in dem er dem Entwickler die Möglichkeit bietet C#-Code zu schreiben, der schlussendlich in Javascript übersetzt wird. Welche Vorteile dieser Ansatz bieten kann, erfahrt ihr in seinem Blog [2].
Ich selber habe die Tools bisher noch nicht ausprobiert, von den Dokumentationskommentaren habe ich jedoch bereits ausgiebig Gebrauch gemacht (wenngleich im Bereich JS bisher ohne Möglichkeit der Auswertung) und kann jedem nur raten ebenfalls auf vergleichbare Arten der Dokumentation zu setzen. Auch Script# stellt einen sehr interessanten Ansatz dar...
... Viel Spaß beim ausprobieren
Kabelsalat
Die Links:
[1] http://weblogs.asp.net/bleroy/archive/2006/05/01/444739.aspx
[2] http://www.nikhilk.net/ScriptSharpIntro.aspx