如果我们为它提供函数或事件处理程序(如我们认为不是一个好工具的GhostDoc),是否有.NET工具可以生成代码的解释(注释)?
答案 0 :(得分:16)
实际上,///
没有生成任何文档,只是空XML标记。 GhostDoc闪耀的地方是自动生成MSDN样式文档(包括词汇),基于上下文信息,如属性,类,可见性,用法等。
以下是一些真正的替代方案:
现在,无论你做什么,请不要生成 undocumentation ! :)
答案 1 :(得分:12)
如果您在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作为您的第一站。这太棒了。
答案 2 :(得分:2)
看看Sandcastle。它将与Visual Studio 2005项目一起使用。还有nDoc的可用下载。它在2005年左右鼎盛时期,但我认为自那以后很少或根本没有发展。
如果您正在寻找能够为您预先填充代码注释的内容,我不确定您是否可以比GhostDoc做得更好。
答案 3 :(得分:1)
甚至没有一种严肃的 GhostDoc替代方案
希望很快能自己启动一个新的开源项目。
PS:如果您遇到挣扎或错误或任何新的错误或错误,请及时更新。