Ich habe Sandcastle mit den Patches getestet, die mit der GUI-Installation mitgeliefert werden, aber wenn ich etwas sehr falsch mache, ist es grundsätzlich ungeeignet für die Dokumentation von F # -Code (auch wenn es für C # wirklich gut funktionieren würde). Vielleicht funktioniert es für andere, in diesem Fall wäre ich sehr dankbar für ein kurzes vollständiges Beispiel, von dem ich ausgehen könnte. Vielen Dank.
Ich bin mir bewusst Sandcastle gibt nicht alles aus einer F # -Assembly aus , aber das dort referenzierte Projekt erscheint noch nicht zur Primetime.
Es muss sicher etwas geben, das zuverlässig funktioniert und "gut genug" ist? Vielen Dank für Anregungen.
Edit: Vielen Dank an alle, die geantwortet haben. Brians Antwort kam mir am nächsten, was ich wollte, also werde ich es akzeptieren. Das Ergebnis ist jedoch, dass es keine Lösung zu geben scheint, die sowohl für F # geeignet ist als auch zuverlässig funktioniert. Ich bleibe jetzt bei Textkommentaren.
Ich erwarte, dass FsHtmlDoc.exe irgendwann funktioniert. Während ich nicht ausschließen kann, dass es schon funktioniert und ich es nicht richtig benutzt habe, deutet das Googeln darauf hin, dass ich nicht der einzige bin, der es noch nicht perfekt findet.
Ich weiß fast nichts über Sandcastle, aber beachten Sie, dass Sie wie C # in F # Tripel-Schrägstrichkommentare verwenden können, die in der XML-Dokumentationsdatei ausgegeben werden, die der Compiler ausgibt (in VS auf der Projekteigenschaftenseite) , Erstellen Sie die Registerkarte, aktivieren Sie das Kontrollkästchen 'Xml-Dokumentationsdatei'; verwenden Sie in der Befehlszeile das --doc -Argument für fsc.exe .)
Siehe auch FsHtmlDoc.exe im PowerPack .
Sie können auch ApiStack von IntelliFactory auschecken. Mir ist klar, dass Focco einen ganz anderen Ansatz benötigt, wenn Sie bereits viele Standard-XML-Dokumentationskommentare haben.
Ich habe es nicht benutzt, aber es könnte sich lohnen, docu zu versuchen ...
Tags und Links f# sandcastle