Question

我刚刚开始研究C＃文档标准。这是我的方法：

/// <summary>
/// Reformats a key in x.x format to 0x0x format
/// </summary>
/// <param name="dotFormatRowKey">key in ##.## format</param>
public static string DotFormatToRowKey(this string dotFormatRowKey) 
{

    if (! Regex.IsMatch(dotFormatRowKey, @"\d+\.\d+"))
       throw new ArgumentException("Expected ##.##, was " + dotFormatRowKey);

    var splits = dotFormatRowKey.Split('.')
                 .Select(x => String.Format("{0:d2}", Int32.Parse(x)))
                 .ToList();
    var joined = String.Join(String.Empty, splits.ToArray())

    return joined;
}

有人可以就如何记录此方法的输入和返回参数向我提供建议。另外，当我这样做时，如果他们使用VS2010 intellisense，那么记录的评论是否可供个人使用？

Answer 1

至于你应该如何记录这些参数：我认为那是非常主观的，但你现在的方式看起来对我来说还不错。尽管如此，你可以将你的返回变量joined更改为更详细的内容，例如"keyFormattedString"或其他内容。

至于问题的第二部分：

此外，当我这样做时，记录的评论可用于如果他们使用VS2010 intellisense？

引自msdn：

扩展方法仅在您明确导入时才在范围内使用using指令将命名空间放入源代码中。

如果方法在类库的某个类中，那么他们必须将该库引用到当前的解决方案中，以便使用/查看方法和记录的注释。您基本上可以创建一个包含所有扩展方法的新类库，然后将该DLL导入到您正在处理的任何解决方案中。

假设您有一个类库，那么您只需添加

using ExtensionMethodsLib; // or whatever you'll call it

到您的使用语句，在您可能需要的任何页面上。

Extension methods (msdn)

如何在C＃中正确记录扩展方法？

1 个答案: