代码文档编辑器答案

【问题标题】：Code documentation editor代码文档编辑器
【发布时间】：2011-10-05 21:37:41
【问题描述】：

我一直在寻找代码文档编辑器应用程序。我指的不仅仅是像 doxygen 这样的生成工具，而是一个允许我编辑文档并直接在代码中更改它的应用程序。

有没有人知道好的编辑器？

谢谢！

【问题讨论】：

如果我理解...您想编辑文档生成工具的输出并查看代码中反映的这些更改吗？
折叠除 cmets 之外的所有内容将使文档编辑变得容易。
@dario_ramos：是的！我想从“管理应用程序”编辑文档，而不是浏览代码并在那里重写文档。
@CatPlusPlus：嗯，使用文本编辑器我可以直接在代码中更改文档，这不是我想要的......我正在寻找除了生成之外的东西（比如doxygen) 还允许我编辑文档。
@Pubby8: 是的，但是当你有大量的代码要记录或处理时，这个过程非常乏味！

【解决方案1】：

如果您说的是 Visual Studio...

我编写了一个插件AtomineerUtils Pro Documentation，它对文档的创建和编辑有很大帮助。

要创建 cmets，插件会使用您正在记录的代码元素中的尽可能多的信息来为您填写框架文档注释。它努力以可读的英文形式提供有用的信息（因此尝试生成有意义的文档，并记录许多从代码本身不是立即“显而易见”的东西，例如方法抛出的异常）
李>
要更新 cmets，它可以将注释与代码同步 - 因此，如果您添加/删除/重命名参数，更改抛出的异常等，它将更新注释以准确反映您的代码的新状态'正在记录。
它应用可配置的自动换行、空白控制和块格式来帮助保持注释块整洁、格式良好和一致。
它支持多种语言（C++、C、C++/CLI、C#、Java、VB）、Xml 文档、Doxygen、Qt 和 JavaDoc 文档格式样式，

如果您想要一个提供所见即所得编辑文档而无需接近源代码的文档系统，那么我相信更像Document!X 的东西可能更适合您的需求（我相信您必须自己编写所有文档，但它的目的更多是编写外部文档而不是提供代码内文档）

当然，对于您的语言/平台/编辑器偏好，这些可能不适用，但是周围还有其他类似的产品，一旦您了解要使用的正确类型的搜索关键字，所以希望这些可能会给您一些线索。

【讨论】：

【解决方案2】：

使用代码编辑器并自动折叠函数体，这样您就看不到它们了。这是做你想做的最简单的方法。抱歉，您还必须管理版本控制。

问题在于代码（和 cmets）在版本控制中并且需要被跟踪。你无法绕过它。

对于它的价值，您会看到编辑代码和 cmets 之间的逻辑差异，但您正在编辑相同的文件。程序员认为这些与事物之间没有区别，并且会被您的术语弄糊涂。我怀疑他们也会和你争论不休，但实际上这只是你使用的词。

【讨论】：