Sandcastle を使用して API ドキュメントを生成する予定です。Web サイトでこれを行う方法に関するガイドが見つかりませんでした。誰かが推奨するクイックスタートガイドはありますか?
3 に答える
8
SHFBを使用することをお勧めします(可能であれば)。非常に簡単です。SHFB にはドキュメントが付属していますが、チュートリアルなしで一般的な機能を使用できます。
于 2009-08-04T18:38:50.653 に答える
2
私はSHFBの強力な支持者でもあるので、2010 年 9 月には Sandcastle と SHFB に関するかなりの記事を書きました。「Taming Sandcastle: A .NET Programmer's Guide to Documenting Your Code」というタイトルで、使用上のヒントと多くの潜在的な落とし穴について説明しています。遭遇する可能性があります。2010 年 10 月に、SHFB の XML ドキュメント コメント レキシコンをまとめた1 ページのウォール チャートを作成しました。
この記事のための私の調査から、他の有用なリソースの完全なリストを以下に示します。
- Eric Woodruff のSandcastle ヘルプ ファイル ビルダー ドキュメント(SHFB クリエーター)
- C# プログラミング ガイド:ドキュメント コメントの推奨タグ(MSDN)
- うーん。Eric Brunsen のXML ドキュメンテーション コメント ガイド(Dynicity)
- Anson Horton のC# による XML ドキュメント(Microsoft C# Compiler Program Manager)
于 2010-10-23T16:27:24.827 に答える
0
SandCastle の ( codeplex ) サイトを確認できるかもしれません。しかし、私の経験では、ただ遊んでみるのが一番です。最初に行う必要があるのは、コメントを XML ファイルに生成する (そしてコードで XML コメントを使用する) ようにアプリケーションを構成することです。これはプロジェクトの設定です。
次にできることは、関連付けられた XML を含むアセンブリを Sandcastle にロードし、設定をいじることです (ほとんどの場合、既定の設定で十分です)。ほとんどの設定は自己文書化されているか、名前を見れば明らかです。
頑張って遊んでください！
于 2009-08-04T18:39:03.273 に答える