F＃コードを文書化する最良の方法は何ですか？

Question

ガイド付きGUIのインストールに含まれているパッチを使用してサンドキャッスルを試しましたが、非常に間違ったことをしていない限り、基本的にF＃コードを文書化するのに適していません（たとえC＃で非常にうまく機能しても）。たぶんそれは他の人のために働くかもしれません。その場合、私は私が始めることができる短い完全な例に非常に感謝するでしょう。どうもありがとう。

気がついた Sandcastleは、F＃アセンブリからすべてを出力しません 、しかし、そこで参照されているプロジェクトは、まだプライムタイムの準備ができていないようです。

確かに確実に機能し、「十分に良い」何かがなければなりませんか？どんな提案にも感謝します。

編集：返信してくれたすべての人に感謝します。ブライアンの答えは私が望んでいたものに最も近かったので、私はそれを受け入れます。ただし、結果は、F＃に適したソリューションではなく、確実に機能するソリューションがないようです。とりあえずテキストコメントに固執します。

fshtmldoc.exeはある時点で動作し始めると思います。私はそれがすでに機能していることを除外することはできませんが、私はそれを正しく使用しなかっただけではありませんでしたが、それがまだ完璧ではないとわかったのは私だけではないことを示唆しています。

Answer 1

Sandcastleについてはほとんど何も知らないが、C＃のようにF＃でトリプルスラッシュコメントを使用できることに注意してください。それらは、コンパイラが出力するXMLドキュメントファイルに出力されることに注意してください（VS、プロジェクトプロパティページ、[ビルド]タブ、「XMLドキュメントファイル」チェックボックスを確認します。コマンドラインで、 --doc への議論 fsc.exe.)

また、参照してください FsHtmlDoc.exe の中に PowerPack.

Answer 2

あなたも見ることができます Focco

素晴らしいHTMLベースのドキュメントを作成します。見る ここ 例：

Answer 3

チェックアウトすることもできます アピスタック から intellifactory. 。標準XML Docのコメントをすでにたくさん持っている場合、Foccoには非常に異なるアプローチが必要であることがわかります。

Answer 4

私はそれを使用していませんが、それは与える価値があるかもしれません docu 試してみてください...