2016-06-27 3 views
3

コメントをc#ブロックすると、特定のパラメータのデフォルト値がクラスconstプロパティであると言いたいと思います。そのパラメータを直接参照する方法はありますか?C#ブロックコメントでconstパラメータを参照する方法はありますか?

私は生成されたドキュメントの値を表示するか、構造化された方法でプロパティにリンクしたいと思います。

この

は私がやろうとしているものの例である: [[DefaultBar]]は上記DefaultBarプロパティを参照する必要があるものは何でも構文です

public class Foo 
{ 
    private const int DefaultBar = 20; 

    ///<summary> 
    ///Does the thing. 
    ///</summary> 
    ///<param name="bar">Description of bar. Defaults to [[DefaultBar]]</param> 
    public int DoTheThing(int bar = DefaultBar) 
    { 
     return bar; 
    } 
} 

定数であるため、手動で同期させることなく、生成されたドキュメントで参照する必要があるようです。

(私は後で他のいくつかのint型へ20を変更したい場合にだけ20[[DefaultBar]]を交換する必要はありません)私はC# "Constant Objects" to use as default parametersに見えたが、その質問(および関連する回答)文書を持っていません。

+0

可能な重複http://stackoverflow.com/questions/5372600/c:たとえば、VSdocman(当社製品)で生成される出力は次のようになります-sharp-constant-objects-to-default-parameters) –

答えて

2

<と同じ定数を参照できます。>コメントタグを参照してください。あなたの場合、それは次のようになります:

public class Foo 
{ 
    private const int DefaultBar = 20; 

    ///<summary> 
    ///Does the thing. 
    ///</summary> 
    ///<param name="bar">Description of bar. Defaults to <see cref="DefaultBar"/>.</param> 
    public int DoTheThing(int bar = DefaultBar) 
    { 
     return bar; 

    } 
} 

これらのコメントからドキュメントを生成すると、定数のページへのリンクが表示されます。 enter image description here

[デフォルトパラメータとして使用するC#「定数オブジェクト」](の
2

IntelliSenseは自動的にそれを追跡します。おそらく、あなたはすでにやるようにコメントして変数名を保つために良い練習になるが、そのメソッドへの参照を入力するとき、それはこのように表示されます:あなたは値を変更するたびので

IntelliSense Example

DefaultBarのIntelliSenseは、更新された値を単独で取得し、ツールチップに配置します。

関連する問題