1、為什么我的VS自帶的類怎么都沒(méi)有注釋了？

? ? ?這是很多同學(xué)經(jīng)常遇到的一個(gè)問(wèn)題，通常我會(huì)讓他們自己切換一下其他的.Net Framework試試，通過(guò)都能解決問(wèn)題，但是究其原因，今天跟大家徹底剖析一下。

? ? ?首先我們要明確一下，dll的注釋是如何來(lái)的，dll天生就是不帶注釋的，如果你看到的dll有注釋，不管是中文還是英文，其實(shí)是通過(guò)與該dll配套的一個(gè)xml文件產(chǎn)生的。

? ? 這樣就很容易理解，為什么切換一下.Net Framework就能讓VS自帶的類變得有注釋了。因?yàn)椴煌?Net Framework的dll在VS安裝目錄里是對(duì)應(yīng)不同的文件夾的，具體可以從下圖看到：

路徑如下：C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework

你打開(kāi)沒(méi)有注釋對(duì)應(yīng)的文件夾與有注釋對(duì)應(yīng)的文件夾，你會(huì)發(fā)現(xiàn)有注釋的dll文件夾里會(huì)多一個(gè)名字叫做zh-Hans的文件夾，所以如果你能把這個(gè)文件夾復(fù)制過(guò)去，其他的.Net Framework也會(huì)有中文注釋。

2、怎么讓我的dll帶有注釋？

? ? ?如果上一個(gè)問(wèn)題可以弄清楚，那么這個(gè)問(wèn)題就變得簡(jiǎn)單了，說(shuō)白了就是需要提供一個(gè)xml文件，但是這個(gè)xml文件難道是直接寫的嗎？

? ? ? 其實(shí)并不是，在你的dll對(duì)應(yīng)的類庫(kù)，右擊屬性中，我們?cè)谏身?yè)面中，可以看到一個(gè)XML文檔文件的選項(xiàng)，勾選一下。

這樣你再次生成的時(shí)候，根目錄下就會(huì)自動(dòng)多一個(gè)同名xml文件，這就是我們需要的xml文件。

但是這個(gè)xml文件里面是沒(méi)有什么內(nèi)容的，你復(fù)制過(guò)去也沒(méi)用，需要你給所有的公共方法屬性，通過(guò)///的方式添加注釋，才會(huì)有意義。至于哪些地方需要加注釋，你勾選之后，編譯一下，自動(dòng)會(huì)告訴你哪些地方需要加注釋。

? ?/// <summary>

? ?///

? ?/// </summary>

注意事項(xiàng)：

最后一個(gè)需要注意的地方，如果xml文件復(fù)制進(jìn)去了，仍然看不到注釋，需要重啟一下VS或者刪除引用重新添加一下。