2015-12-08 100 views
2

如果我的類有一個註釋過的公共屬性,它是通過構造函數分配的,我可以從具有相同名稱的構造函數參數的描述中引用它的描述嗎?我可以在構造函數註釋中引用屬性註釋嗎?

public class MyClass 
{ 
    /// <summary> 
    /// x description 
    /// </summary> 
    public int x { get; private set; } 
    /// <summary> 
    /// y description 
    /// </summary> 
    public int y { get; private set; } 
    /// <summary> 
    /// Constructor description 
    /// </summary> 
    /// <param name="x">How do I reference x description from here?</param> 
    /// <param name="y">And y description?</param> 
    public MyClass(int x, int y) 
    { 
     this.x = x; 
     this.y = y; 
    } 
} 

回答

7

不能包括的描述,但可以鏈接到該屬性文件與<see>標籤。例如:

<param name="x">The initial value for <see cref="x"/></param> 

另外,我強烈建議您遵循.NET命名約定,公共成員以大寫字母開頭。

+0

但我仍然想知道如何使用這個cref,我打開了生成的xml,只看到x被x的全名替換。並且在智能中也沒有看到'x描述'。 –

+0

@LeiYang:不,如我所說,不會包含*描述 - 但是當您生成文檔時,會在HTML中包含該屬性的鏈接。 –

相關問題