についてコメントを行頭に付けた機能とVisual Studio?

StackOverflow https://stackoverflow.com/questions/529677

質問

Visual Studioおよびスレッドセーフで、C＃、使用時は内蔵機能などのToString(),頭に付けを示す黄色のボックスを説明するか。

alt text alt text

どのようにしているための機能や特性を書いてるんだ?

役に立ちましたか？

解決

を生成する領域を指定することができ説明可能であり、各パラメータの機能には、次のライン前の機能にヒット 入:

  • C#: ///

  • VB: '''

見 おすすめのタグの文書のコメント(C#プログラミングガイド) のための詳細情報の構造化されたコンテンツを含めることができ、これらのコメントです。

他のヒント

必要なものは xmlコメント -基本的には、この構文として曖昧に記述されるSolmead):

C#

///<summary>
///This is a description of my function.
///</summary>
string myFunction() {
     return "blah";
}

VB

'''<summary>
'''This is a description of my function.
'''</summary>
Function myFunction() As String
    Return "blah"
End Function

<c>text</c> -テキストだとしている。
の <c>タグを使うことを示すためにテキスト内に記述で示しています。使用 <コード>への示す複数のラインとしてのコードです。

<code>content</code> -したいテキストを示しています。
の <コード>タグをする方法を示す複数のラインとしてのコードです。使用 <c>ることを示すためにテキスト内に記述で示しています。

<example>description</example> -のコードサンプルです。
の <例>タグのnameタグで指定した方法の例を使用方法やその他の図書館。この共通として有用である <コード>タグです。

<exception cref="member">description</exception> -例外の説明.
の <例外>タグのnameタグで指定する例外がスローされます。このタグで定義メソッド、プロパティ、イベント、インデクサに最適.

<include file='filename' path='tagpath[@name="id"]' />
の <など>ターを参照してコメントを別のファイルの種類および担当のソースコード。この代替注文書のコメントは直接ソースコードファイルです。を入れることによって書類を別のファイルで、ソース管理、ドキュメントとは別に、ソースコードです。一人のソースコードファイルをロック、他の誰かができ、文書ファイルを確認する。の <など>タグのXML XPath構文です。を参照してXPath文書のための方法をカスタマイズ <など>利用します。

<list type="bullet" | "number" | "table">
    <listheader>
        <term>term</term>
        <description>description</description>
    </listheader>
    <item>
        <term>term</term>
        <description>description</description>
    </item>
</list>

の <listheader>ブロックを定義するために使用され、見出し行のいずれかのテーブル定義が一覧です。定義のテーブルだけを提供する必要がありエントリのための期間の見出しを表示します。各項目のリストを指定すると、 <項目>ブロックです。作成時に定義リストを指定する必要があります両方の期間とする。しかし、テーブル、箇条書きは、番号リストだけを提供する必要がありエントリ。リストまたはテーブルで多くの <項目>ブロックしています。

<para>content</para>
の <パラ>タグを使うことができるのは内部タグなど <概要>, <備考>、 <を返します>くご利用いただいてい構成にします。

<param name="name">description</param>
の <param>タグを使用する必要があるコメントのための方法宣言の記述のためのパラメータの研究"に関するお問合せ記複数のパラメータは、複数の <param>タグです。
テキストの <param>タグが表示されまを行頭に付けた、オブジェクトブラウザのコードのコメントWebで報告する。

<paramref name="name"/>
の <paramref>タグを使うことを示すための単語のコードのコメントは、例えば、 <概要>または <備考>ブロックとパラメータとします。のXMLファイルを処理することにより形式のこの言葉も異なる、などの大胆なやitalicの商標または登録商標です。

<permission cref="member">description</permission>
の <許可>タグでき文書のアクセスします。のPermissionSetクラスで指定したアクセスします。

<remarks>description</remarks>
の <備考>タグを追加するために使用に関する情報タイプの補助の情報で指定された <概要>.これらの情報が表示されるオブジェクトブラウザです。

<returns>description</returns>
の <を返します>タグを使用する必要があるコメントのための方法宣言の記述を返します。

<see cref="member"/>
の <見>タグのnameタグで指定したリンクからテキストがあるとします。使用 <seealso>ることを示すためにテキストに置かれることなどを参照してください.利用のcref属性を内部のリンクをドキュメンテーションのためのコードです。

<seealso cref="member"/>
の <seealso>タグのnameタグで指定するテキストするために表示されます。使用 <見 設定のリンクからテキストがあるとします。

<summary>description</summary>
の <概要>タグを使用する必要を記述する型はa型。使用 <備考>への追加は別途料金がかかります。タイプ。利用のcref属性を文書化ツールなどの設を内部のリンクをドキュメンテーションのためのコードです。テキストの <概要>タグの情報をタイプを行頭に付けたものに表示されたオブジェクトブラウザです。

<typeparam name="name">description</typeparam>
の <typeparam>タグを使用する必要があるコメントのための汎用タイプやメソッド宣言を記述するための型パラメータとします。追加タグをそれぞれの型パラメータの汎用型または方法です。テキストの <typeparam>タグが表示されまを行頭に付けた、オブジェクトブラウザのコードのコメントwebで報告する。

<typeparamref name="name"/>
本タグを利用する消費者の文書ファイルフォーマットの一つは、例えば致します。

<value>property-description</value>
の <値>タグで記述しておきの価値る物件を表します。りますのでご注意くださの追加物件コードウィザードのないようにした。NET開発環境までを追加 <概要>タグの新しい物件です。きを手動で追加す <値>タグを記述する値ることを表します。

なXMLコメントを、こんな感じ

/// <summary>
/// This does something that is awesome
/// </summary>
public void doesSomethingAwesome() {}

利用///を始め各行のコメントとしてのコメントを含んでい 適切なxml のためのメタデータ読み取り.

///<summary>
/// this method says hello
///</summary>
public void SayHello();

が個人的には、こうしたコメントは、通常、間違った方向に誘導された場合を除き、開発の授業が、コードを読み込むことができませんより消費者です。

それという XMLコメント.その一部となってきましたVisual Studioです。

お客様の文書作成を利用し、簡単に GhostDoc, 無料add-in for Visual Studioを生成するXML-docコメントします。んごキャレットのメソッド/プロパティしたい文書やCtrl-Shift-D.

この一例から 一ん.

こ:)

に圧倒的な支持を得た場合、作成方法/機能概要でParms、そのときに追加のスラッシュのみで自動作成の概要およびparmsます。

いくつろぎいただけます: 

public string myMethod(string sImput1, int iInput2)
{
}

そして、三///と、Visual Studioのにしてくれたこ

/// <summary>
/// 
/// </summary>
/// <param name="sImput1"></param>
/// <param name="iInput2"></param>
/// <returns></returns>
public string myMethod(string sImput1, int iInput2)
{
}

読む http://msdn.microsoft.com/en-us/library/3260k4x7.aspx だけを指定するコメントはルをダウンロードするコメントを行頭に付けた.

定義の方法のようなことを取得します。

    /// <summary>
    /// Adds two numbers and returns the result
    /// </summary>
    /// <param name="first">first number to add</param>
    /// <param name="second">second number to </param>
    /// <returns></returns>
    private int Add(int first, int second)
    {
        return first + second;
    }

スクリーンショットのコードの利用

また、visual studioトゴーストのdocフレーバを作成-入力にはヘッダーからコメント機能の名前です。

これらすべての他人の回答の意味が不完全なものです。Visual Studioの研修事業サポート,中国ビジネスはXMLコメントしててくれます。こちらはどのような:

を行頭に付けたまま使用XMLコメントを入力するソースコードもすべて有効にしてVisual Studioです。へ Tools > Options > Text Editor.のためのVisual Basicにより、 Advanced > Generate XML documentation comments for ''' 設定あり。C#により、 Advanced > Generate XML documentation comments for /// 設定あり。を行頭に付けの概要コメントを入力します。を行っていますから他のプロジェクトの後で参照されるプロジェクトが取りまとめを行いました。

作 外部 文書を作成するXMLファイルの Project Settings > Build > XML documentation file: 経路制御するコンパイラの /doc オプションです。必要な外部ツールのXMLファイルの入力としての発生に資料をご希望の出力形式

この生成、XMLファイルが著増加をコンパイルす。

Solmeadの正しい答えです。詳細を見ることが出来ま XMLコメント.

ライセンス： CC-BY-SA と 帰属
所属していません StackOverflow
scroll top