私は常に、C# xml 構文を使用して、クラスとメソッドの適切なコード コメントを書くことを強調してきました。後で簡単にエクスポートできるといつも思っていました。
今日、私は実際にそうしなければなりませんが、方法を見つけるのに苦労しています。足りないものはありますか?Menu->Build->Build Code Documentationに移動したいのですが、それを行うオプションはありません。
私は常に、C# xml 構文を使用して、クラスとメソッドの適切なコード コメントを書くことを強調してきました。後で簡単にエクスポートできるといつも思っていました。
今日、私は実際にそうしなければなりませんが、方法を見つけるのに苦労しています。足りないものはありますか?Menu->Build->Build Code Documentationに移動したいのですが、それを行うオプションはありません。
実際にはプロジェクトのプロパティにあります。[ビルド] タブ、[出力] セクション、XML ドキュメント ファイルを開き、ファイル名を入力します。プロジェクトのすべてのビルドでビルドされます。
その後、Sandcastleを使用して実際のヘルプを構築できます。
サードパーティのツールを使用してもかまわない場合は、NDOCまたはSandCastleを試すことができます。
Sandcastleは、ドキュメントの生成に非常によく機能し、生成用にいくつかの異なる形式をサポートしています。私の知る限り、Visual Studio との統合はありませんが、利用可能なSandcastleGUIがあります。
自動生成されたオブジェクトに持続可能なコメントを簡単に追加できないため、LINQ to SQL を使用している場合は注意してください。
元の NDoc プロジェクト (他の人が言及) は終了しましたが、 NDoc3という新しいプロジェクトがあります。
NDoc3 は .NET 2.0 ~ 3.5 をサポートします。現在ベータ版として利用可能で、私にとってはうまくいきました. プロジェクトがまだアクティブかどうかはわかりません - 最後のベータ版は 2009 年 4 月にリリースされました。