將XML註釋移動到單獨的文件

我愛XML comments。然而，一切倒塌，每兩行的樣子：將XML註釋移動到單獨的文件

[/// summary ...] 
public void CreateUser(string username, string password)[...]

乘這個由數十或數百個方法，產生的摺疊的代碼是很難通過篩選。 我可以將這些註釋移動到單獨的XML文件，並且仍然讓Visual Studio識別該關聯，以便它們仍顯示在Intellisense中？如果是這樣，我該如何建立這種關係？而且我還使用SandCastle根據這些評論生成文檔，因此該協會也必須得到SandCastle的認可。

來源

2012-07-18 CptSupermrkt

您可以使用<include file='...' path='...'>標記來引用外部註釋。見http://msdn.microsoft.com/en-us/library/9h8dy30z.aspx。

我不知道任何將現有源文件中的註釋移動到外部註釋文件的工具。

來源

2012-07-18 03:43:40

太棒了，謝謝。這看起來有希望。 – CptSupermrkt 2012-07-18 05:19:04

簡短的回答：據我所知號

XML註釋是公開曝光的方法，將被第三方使用的有用。由於我添加到應用程序中的幾乎所有面向公衆的功能都是通過契約接口完成的（輔助測試能力），我將把註釋與接口聲明進行比較，並使用<，參見上面的cref =「...」/ >實現。

接口：

///<summary> 
/// Provides so-in-so fetching functionality on the provided criteria. 
/// Examples, parameters, etc. 
///</summary> 
IEnumarable<Something> FetchSomethingsBaseOnCriteria(params Criteria[] criteria);

實施

///<summary> 
/// <see cref="ISomethingDoer.FetchSomethingsBasedOnCriteria"/> 
///</summary> 
IEnumarable<Something> ISomethingDoer.FetchSomethingsBaseOnCriteria(params Criteria[] criteria) 
{ 
    // Get fetching... 
}

不知道大多數文檔生成器必須解決從<評論見/ >的智慧，我相信沙堡有< Inheritdoc/>標籤，該標籤將允許它採用基本界面的評論。 http://www.ewoodruff.us/shfbdocs/html/79897974-ffc9-4b84-91a5-e50c66a0221d.htm

如果您使用多態接口，這可能無法正常工作。（我不認爲你可以覆蓋中介界面中的聲明/評論）

對於內部使用和私人代碼，我不打擾評論，因爲它是額外的開銷，經常解釋明顯的。他們太容易讓他們失去同步，在這種情況下，他們開始誤導用戶或需要被忽略。（「評論謊言」 - 清潔代碼）我依賴於BDD風格的單元測試來描述我打算做的代碼以及描述自己的描述性代碼。

來源

2012-07-18 03:05:11

將XML註釋移動到單獨的文件

回答

相關問題