2012-10-07 11 views
8

対象を指すコード内のリンクを使用してドキュメントの種類を作成したいと考えています。ターゲットはClassまたはMethodまたは特定のコード行になります。 (特定のコード行を指しているが最も重要です
私はVS2010の拡張または特定のコメントタグを考えました。
この種のリンクを作成する方法はありますか?C#のクラス、メソッド、特に特定のコード行にリンクする方法

+3

Javadocはこの種のことを正確に行うことができました。 Microsoftが.Net 1.1をリリースしたとき、Javadocを「NDoc」で模倣しようとした。それから、「Sandcastle」のためにNDocを殺害した:http://weblogs.asp.net/fmarguerie/archive/2006/02/16/ndoc-project-stalled-no-version-2-microsoft.aspx。彼らの現在のXMLのことは、率直に言って、混乱です...お勧め:代わりに[Doxygen](http://www.stack.nl/~dimitri/doxygen/)の使用を検討してください。 – paulsm4

+0

@HichemC、try [this](http://hyperaddin.codeplex.com/) –

+1

私はそれを試してみましたが、うまくいくと思います - アドインを登録し、Help.htmを使ってその使い方を学んでください。何か問題がある場合(VS 2005および2008用に構築されているため)、ソリューションを再構築できます(オープンソースです)。正常に動作するはずです。 –

答えて

9

Xmlコメント+砂時計が必要な場合があります。あなたは

<see cref=".."/> 

<paramref name=".."/> 

を使用して参照パラメータを使用して、指定されたクラスやメソッドを参照することができますしかし、そこにコードの特定の行を参照するための直接的な方法ではありませんが、あなたは

を使用して、特定の#regionを参照することができ
<code source="$sourcefile$" region="$regionname$"/> 

を参照してください:XML Comments Guide 20ページ

あなたが参照するコードは、リンクではなくその場所に直接表示されることに注意してください。完璧ではありませんが、それが助けてくれることを願っています

+0

かなり役に立ちました。ありがとう – HichemSeeSharp

関連する問題