GhostDoc 类型工具的替代工具答案

【问题标题】：Alternate tool for a GhostDoc type of toolGhostDoc 类型工具的替代工具
【发布时间】：2011-03-16 21:33:42
【问题描述】：

如果我们给它提供函数或事件处理程序（如GhostDoc，我们认为这不是一个好工具），是否有一个 .NET 工具会生成代码解释 (cmets)？

【问题讨论】：

【解决方案1】：

实际上，/// 不会生成任何文档，只是空的 XML 标记。 GhostDoc 的亮点在于根据属性、类、可见性、用法等上下文信息自动生成 MSDN 样式文档（包括措辞）。

这里有一些真正的选择：

现在，无论你做什么，请不要产生undocumentation！ :)

【讨论】：

最后，我为 MSDN 文档的恐怖取了一个名字：“Undocumentation”。
你说不要产生undocumentation，而这正是GhostDoc所做的。
你应该在之后写点什么。不要只管它。这就是我所说的不产生无证文件的意思。 :)
GhostDoc 不会做任何您通过键入 ///<TAB> 已经无法做到的事情。它根据事物的名称组成 cmets，但这毫无意义。可以从事物名称中收集到的信息是对文档的浪费。文档应解释重要信息的时间过长，无法以名称命名。 GhostDoc 无法做到这一点。现在，如果您认为 GhostDoc 做了 ///<TAB> 无法做到的事情，我很想知道那是什么。但是this article from a year ago 表明 GhostDoc 仍然会产生无文档。
不，瑞恩，我不是。我不明白我是如何把它变成个人的。我试图澄清一下。

【解决方案2】：

如果您在 VS2010 中使用 /// 开始注释，它会根据您正在注释的功能在 XML 中为您创建基本参数。

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

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

如果您想从中生成体面的文档，我建议您将https://github.com/EWSoftware/SHFB 作为您的第一站。可以说是王牌了

【讨论】：

VS 2005 也会在三个正斜杠上创建 XML cmets。
VS 是一款出色产品的另一个原因。这也适用于独立的 Visual Express 产品，例如 VWD2008/10、VC# 2008/10。
所有 XML 注释都将类似于 Ghostdoc - 重要的是您输入的 cmets 的质量，而不是用于生成它们的程序。自动生成的 cmets 只会作为方法签名的占位符 - 您仍然需要用有用的信息填写它们，否则您生成的文档将非常少。

【解决方案3】：

看看Sandcastle。它适用于 Visual Studio 2005 项目。 nDoc 也有下载。它在 2005 年左右达到了鼎盛时期，但我认为从那以后几乎没有发展。

如果您正在寻找能够真正为您预填充代码 cmets 的东西，我不确定您能比 GhostDoc 做得更好。

【讨论】：

【解决方案4】：

甚至没有一个严肃的 GhostDoc 替代方案

我希望我自己很快就会开始一个新的开源项目。
PS：如果您发现任何问题或错误或任何新问题，请更新我。

【讨论】：