一千萬個為什麽

搜索

C#XMLコメントの再利用

私はC#クラスライブラリを作成しています。クラスライブラリには、ほぼ同じことを行う関數を持つクラスがいくつかあります。私は非常に詳細ですが、ほとんどの場合同じように各クラスの関數の引數についてXMLコメントを提供する必要があります。 XMLコメントを再利用する方法があるので、私はこれらのXML引數定義をアセンブリ全體で繰り返す必要はありませんか?

クラスの例を次に示します。

public class IsodoseControl : TestModule
{
    /// 
/// Verify a control on Isodose dialog ///
 
    /// 
  **<-- WHAT I DON'T WANT TO KEEP REPEATING**
    /// Arguments: [Property, Condition, Expected Value, Tolerance]
    ///            Properties: STATE, VALUE, LABEL
    ///            Conditions: Exists, DoesNotExist, IsEnabled, IsDisabled, ...
    ///            Expected Value (optional): blah blah
    ///            Tolerance (optional): blah blah blah
    /// 
    public VerifResult VerifyIsodoseControl(string[] args)
    {
        ...
    }
}

public class BeamControl : TestModule
{
    /// 
/// Verify a control on Beam dialog ///
 
    /// 
  **<-- WHAT I DON'T WANT TO KEEP REPEATING**
    /// Arguments: [Property, Condition, Expected Value, Tolerance]
    ///            Properties: STATE, VALUE, LABEL
    ///            Conditions: Exists, DoesNotExist, IsEnabled, IsDisabled, ...
    ///            Expected Value (optional): blah blah
    ///            Tolerance (optional): blah blah blah
    /// 
    public VerifResult VerifyBeamControl(string[] args)
    {
        ...
    }
}

ありがとう

最佳答案

"The tag lets you refer to comments in another file that describe the types and members in your source code. "

You could reference the same file from both classes using tags.

/// 
class OneClass {}

/// 
class DifferentClassWithTheSameFunctionality {}

This link provides some examples of using : http://msdn.microsoft.com/en-us/library/9h8dy30z.aspx

轉載註明原文: C#XMLコメントの再利用