生成方法后，如何在Visual Studio中的方法的注釋中添加參數？

Question

我有如下評論：

/// <summary>
///     Creates a filename given the end date provided
/// </summary
/// <returns></returns>
public static string GetFileName(DateTime date, string filePath) {
        var ret = string.Format("file_{0}[{1}].txt", date.ToString("yyyyMMdd"), date.ToString("HHmm"));
        return Path.Combine(filePath, ret);
    }

當我鍵入///時，Visual Studio會自動在上面創建注釋。

是否可以重新生成上述注釋並添加我最近新添加的參數？

我知道我可以通過輸入///來刪除和重做它，它將使用適當的參數自動生成。 有其他方法嗎？

Answer 1

GhostDoc是Visual Studio擴展，可以幫助生成這些類型的文檔。

我也聽說過有關Resharper的好消息，但還沒有親自使用過。

否則，我通常只要改變///即可。

Answer 2

首先 ，您可以通過在摘要中添加必要的<param>項來手動完成此操作。

/// <summary>
///     Creates a filename given the end date provided
/// </summary>
/// <param name="date">It is a date</param>
/// <param name="filePath">Valid path</param>
/// <returns></returns>
public static string GetFileName(DateTime date, string filePath) {
   var ret = string.Format("file_{0}[{1}].txt", date.ToString("yyyyMMdd"), date.ToString("HHmm"));
    return Path.Combine(filePath, ret);
}

其次 （對於懶惰的人），您可以刪除此注釋並再次輸入“ ///” :)

Answer 3

GhostDoc是TheMi7ch所建議的工具。 您可以使用“工具”菜單下的“ Visual Studio擴展和更新”下載它。

Answer 4

Intellisense對我來說效果很好：

1. 轉到</summary>行的末尾並按Enter鍵-VS將生成一個已經///的新行。
2. 鍵入<p和Intellisense應該會給您一些很好的建議。

在某些設置中，我已經看到Intellisense只是列出所有缺少的param標簽，您可以通過這種方式一個一個地添加它們。 在其他設置上，它只會給您<param name=""></param>並將插入點放在引號之間，以便您填寫參數名稱。 我猜您將獲得哪種行為取決於您是否安裝了Resharper。