Was ist der beste Weg, um F# Code zu dokumentieren?

Question

Ich habe Sandcastle mit den Patches ausprobiert, die in der geführten GUI -Installation enthalten sind, aber wenn ich nichts sehr falsch mache, ist es im Grunde genommen ungeeignet, F# Code zu dokumentieren (auch wenn es für C# wirklich gut funktioniert). Vielleicht funktioniert es für andere, in diesem Fall wäre ich sehr dankbar für ein kurzes Beispiel, mit dem ich anfangen könnte. Danke vielmals.

Ich bin mir bewusst, dass Sandcastle gibt nicht alles von einer F# -Anbaugruppe aus , aber auf das darauf verwiesene Projekt erscheinen noch nicht bereit für die Hauptsendezeit.

Es muss sicherlich etwas geben, das zuverlässig funktioniert und "gut genug" ist? Vielen Dank für alle Vorschläge.

EDIT: Vielen Dank an alle, die geantwortet haben. Brians Antwort war dem, was ich wollte, am nächsten, also werde ich sie akzeptieren. Das Ergebnis ist jedoch, dass es keine Lösung gibt, die sowohl für F# geeignet ist als auch zuverlässig funktioniert. Ich werde vorerst bei Textkommentaren bleiben.

Ich gehe davon aus, dass FSHTMLDOC.exe irgendwann funktionieren wird. Obwohl ich nicht ausschließen kann, dass es bereits funktioniert und ich es einfach nicht richtig verwendet habe, deutet das Googeln darauf hin, dass ich nicht der einzige bin, der es noch nicht perfekt findet.

Answer 1

Ich weiß so gut wie nichts über Sandcastle, aber beachten Sie, dass Sie wie C# in F# Triple-Slash-Kommentare verwenden können und sie in der XML-Dokumentationsdatei ausgeben, die der Compiler ausgibt (in VS, auf der Seite "Projekteigenschaften", Build-Registerkarte "Build" Überprüfen Sie das Kontrollkästchen "XML -Dokumentationsdatei". Verwenden Sie in der Befehlszeile die --doc Argument an fsc.exe.)

Siehe auch FsHtmlDoc.exe in dem Netzteil.

Answer 2

Sie könnten sich auch ansehen Focco

Es erzeugt eine schöne HTML -basierte Dokumentation. Sehen hier zum Beispiel:

Answer 3

Sie können auch auschecken Apistack aus Intellifaktorisch. Mir ist klar, dass FOCCO einen ganz anderen Ansatz erfordert, wenn Sie bereits viele Standard -XML -DOC -Kommentare haben.

Answer 4

Ich habe es nicht benutzt, aber es könnte sich lohnt, Geben zu geben Doku ein Versuch...