如何將文件夾級別文檔添加到C＃程序集？

我：我是.NET平臺的新手。如何將文件夾級別文檔添加到C＃程序集？

問題

在Java中，你可以通過創建一個package-info.java或package.html的文件和包文件夾添加存儲封裝級文件到您的項目。如何使用Visual Studio 2010將等效文檔添加到C＃項目中？

背景

我喜歡寫文檔描述，我的工作的源代碼項目的包/文件夾級別方面，我國的動機。我已經習慣了使用各種語言（特別是Java）的這種工作流程，我相信這是記錄我的項目的好方法。

來源

2010-05-24 Elijah

.NET的焦點有點不同，它對生成IntelliSense信息有很好的支持。在您的指尖提供文檔。我相信你在使用VS一段時間後對它很熟悉，查找「xml文檔」。

脫機文檔曾被NDoc覆蓋，但支持它的人退出了他的項目。該Sandcastle project佔用了鬆懈。似乎有點遲緩這些天順便說一句。

來源

2010-05-24 23:07:23

C＃會自動將基於XML的tripple-slash註釋轉換爲intellisense文檔。

///<summary>This method does something!</summary> 
///<parameter name="p1">The first parameter</parameter> 
///<return>true, if the method completed successfully</return> 
public bool DoSomething(int p1){ 
    return p1 > 0; 
}

當您將項目編譯到類庫並在另一個項目中引用它時，上述內容將自動轉化爲有用的工具提示。另外，C＃編譯器還可以隨DLL一起生成一個包含所有這些註釋的XML文件。這個XML文件可以輸入到Sandcastle（如前所述）並作爲MSDN風格的API參考添加到文檔項目中。

Sandcastle工具具有自己的項目和文檔結構，因此如果要添加比XML生成的Intellisense引用更多的內容，則需要啓動一個側項目。

來源

2010-05-24 23:17:02

如何將文件夾級別文檔添加到C＃程序集？

回答

相關問題