https://docs.microsoft.com/zh-cn/dotnet/csharp/language-reference/language-specification/documentation-comments#an-example
微軟官方文檔。
我想補充幾點。
1.如果想要所有類或者方法都添加文檔注釋,而自己總容易忘記添加或者漏添加的話。可以試試這個辦法:
在項目上右鍵--屬性--生成--勾選下圖所示的選項
如果你沒有添加文檔注釋,將會作為警告顯示。
2.如果你有強迫症。(我就有) 覺得警告不過癮,把它當作錯誤顯示,不添加文檔注釋就不讓編譯通過。
那么你可以這樣做:
在第一步的基礎上。
在項目上右鍵--屬性--生成--勾選下圖所示的選項
當然了,你也可以勾所有。(不推薦,因為大多數時候會有很多頁面的警告。)
解釋一下這三個常用警告:
CS1591:沒有<summary>
CS1573:方法中有參數,但是沒加參數注釋<param> (還有一種是相反的,有<param>,但是沒參數--CS1572 這種不常用)
CS1574:cref屬性中的類或者符號找不到。(用法:<see cref=""/> 或者 <seealso cref="" />)
3.cref屬性里面如果引用泛型類需要這樣寫<see cref="Product{TItem}" />
如果引用操作符號需要這樣寫<see cref="operator==" />