2008-12-26 19 views
6

在C#的XML文檔註釋中,有沒有辦法將兩個或多個函數標記爲彼此的重載,以便它們自動引用對方?理想情況下,它們也會以某種方式分組在沙堡生成的文檔中。如何在C#XML註釋中鏈接/分組重載?

目的:通常,我想鏈接到這組函數,例如,在效用函數列表中,只需提及其中的一個重載,並使其他人很容易從那裏發現。

目前我正在添加鏈接,但那很乏味。

回答

2

多重過載之間的關係已被XMl文檔和Sandcastle識別和分組。

使用seeseealso標籤創建與其他成員的鏈接。

例如,

///See <see cref="M:AnotherMethod(System.String)"> 

雖然我發現Sandcastle成員分辨率可能會有點片狀,所以我傾向於使用完全限定名稱。

///See <see cref="M:MyCompany.Myapp.MyClass.AnotherMethod(System.String)"> 

注意M:表示一個成員正在被引用,您還使用E:指向一個事件。 T:用於類型,但如果不存在,則假定該類型。

1

分組由沙堡,右自動完成的,但如果你想給重載組共同的描述,使用<重載>標籤這個(以同樣的方式作爲<總結>)。 它不是一個標準的XML文檔標籤,而是由Sandcastle Help File Builder支持的AFAIR。

+0

這很漂亮。有沒有關於標籤屬性的在線文檔? – smaglio81 2010-02-11 01:11:35