GhostDoc工具类型的备用工具

Question

是否有一个.NET工具,如果我们给它功能或事件处理程序(如我们认为不是一个好工具的GhostDoc),它将生成代码的解释(注释)？

Answer 1

实际上,///不生成任何文档,只是空XML标记.GhostDoc闪耀的地方是自动生成MSDN样式文档(包括verbiage),基于上下文信息,如属性,类,可见性,用法等.

以下是一些真正的替代品:

• Atomineer(比GhostDoc便宜一点)
• Resharper(仅当您为项目启用XML注释时才有效,但远不及上面的两个.也可以从基类/接口复制XML注释).

现在,无论你做什么,请不要产生无证!:)

Answer 2

如果您在VS2010中使用///开始评论,它将根据您正在评论的功能为您创建XML的基本参数.

http://msdn.microsoft.com/en-us/magazine/dd722812.aspx

所以在函数startMonitor(ManagementScope scope)给出前输入/// ...

/// <summary>
/// 
/// </summary>
/// <param name="scope"></param>
static void startMonitor(ManagementScope scope)

如果你想从这些文件生成合适的文档,我建议你https://github.com/EWSoftware/SHFB作为你的第一站.这太棒了.