web-dev-qa-db-ja.com

C#コードのHTMLドキュメントを作成する

私は現在C#プロジェクトに取り組んでおり、VisualAssistはこれらの空想を生成します/// <summary></summary>私のためのコメントと私はそれらを使用してきたコードを文書化します。

これらのコメントを使用して、DoxygenやJavadocが行うようなHTMLドキュメントを作成する方法があるに違いないと思います。それ、どうやったら出来るの?

51
jaho

Doxygen または Sandcastle help file builder は、外部ドキュメントのHTML(およびその他の形式)にXMLドキュメントを抽出する主要なツールです。

これらのドキュメントエクスポーターをドキュメントジェネレーターと組み合わせることができることに注意してください-発見したように、Resharperには初歩的なヘルパーがいくつかありますが、 GhostDoc (for XMLドキュメントを含むC#/ VBコード)または私のアドイン Atomineer Proドキュメント (C#、C++/CLI、C++、C、VB、Java、JavaScript、TypeScript、JScript、PHP、XMLを含むUnrealscriptコード、 Doxygen、JavaDoc、またはQtのドキュメント)。

39
Jason Williams

2017年には、Javadocに最も近いものはおそらく DocFx であり、これはMicrosoftによって開発され、Commmand-Line-ToolおよびVS2017プラグインとして提供されます。

エッジの周りはまだ少し荒いですが、有望に見えます。

別の代替手段は Wyam で、これにはネットアプリケーションに適したドキュメントレシピがあります。例については cake documentation をご覧ください。

28
mode777

このページに興味があるかもしれません: http://msdn.Microsoft.com/en-us/magazine/dd722812.aspx

コマンドラインコンパイラまたはVisual Studioインターフェイスを使用して、XMLドキュメントファイルを生成できます。コマンドラインコンパイラでコンパイルする場合は、オプション/ docまたは/ doc +を使用します。これにより、アセンブリと同じ名前で同じパスにXMLファイルが生成されます。別のファイル名を指定するには、/ doc:fileを使用します。

Visual Studioインターフェイスを使用している場合、XMLドキュメントファイルを生成するかどうかを制御する設定があります。設定するには、ソリューションエクスプローラーで[マイプロジェクト]をダブルクリックして、プロジェクトデザイナーを開きます。 [コンパイル]タブに移動します。ウィンドウの下部にある「XMLドキュメントファイルの生成」を見つけて、チェックされていることを確認します。デフォルトでは、この設定はオンです。アセンブリと同じ名前とパスを使用してXMLファイルを生成します。

3
Kevin Lindsay

Visual Studioの上記の方法はVisual Studio 2013には適用されていないようですが、プロジェクトメニューを使用してプロジェクト(おそらくサブメニューの最後のアイテム)を選択し、ダイアログを表示して、チェックボックス([ビルド]タブ)。

1
George Hahn