MVC WebApi 文件生成注釋說明的方法

2021-08-08 19:06:59 字數 580 閱讀 9684

首先要配置專案可以生成xml說明文件..

右擊你的專案->生成->輸出->勾上 xml文件檔案 然後把這個檔名放在下面的**裡.

在你的方法上加上說明文件例如:

///

/// 獲取使用者資訊,這個就會顯示在說明文件裡面

//////

// get api/account/userinfo

[hostauthentication(defaultauthenticationtypes.externalbearer)]

[route("userinfo")]

public userinfoviewmodel getuserinfo();}

然後就可以了.

使用C XML 文件注釋生成API幫助文件

c xml 文件注釋 description 描述型別或型別成員。description 物件的摘要。description 新增有關某個型別的資訊,從而補充由 所指定的資訊。description 成員的說明。description 使用方法或其他庫成員的示例。這通常涉及使用標記。descript...

將C 文件注釋生成 chm幫助文件

完整的文件情訪問 由於最近需要把以前的乙個專案寫乙個文件,但一時又不知道寫成怎樣的,又恰好發現了可以生成chm的工具,於是乎我就研究了下,感覺還不錯,所以也給大家分享下。好了,不多廢話,下面就來實現一下吧。生成前的準備 在開始做之前,還是要補充說明一點 我們是通過c 文件注釋生成的xml檔案來生成幫...

phpdoc注釋格式及文件生成

舊版本使用步驟 1 win下安裝pear file file2 f go pear.phar open the file to get existing content current file get contents file write the contents back to the fil...