代码文档编辑器

Question

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

有没有人知道一个好的编辑？

谢谢！

Answer 1

如果你在谈论Visual Studio ......

我已经编写了一个加载项AtomineerUtils Pro Documentation，这对文档创建有很大帮助。编辑。

• 要创建注释，addin会从您正在记录的代码元素中尽可能多地使用信息，以便为您提供框架文档注释。它努力以可读的英语形式提供有用的信息（因此尝试生成有意义的文档，并记录许多从代码本身不是立即“显而易见”的事情，如方法抛出的异常）

• 要更新注释，它可以将注释与代码同步 - 因此，如果添加/删除/重命名参数，更改抛出的异常等，它将更新注释以准确反映代码的新状态“记录。

• 它应用可配置的自动换行，空格控制和块格式化，以帮助保持注释块整洁，格式良好且一致。

• 它支持大量的语言（C ++，C，C ++ / CLI，C＃，Java，VB），Xml文档，Doxygen，Qt和JavaDoc文档格式，

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

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

Answer 2

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

问题是代码（和注释）处于版本控制之下，并且需要被跟踪。你不能绕过它。

对于它的价值，您会看到编辑代码和注释之间存在逻辑差异，但您正在编辑相同的文件。程序员看到这些与事物之间没有区别，你的术语会让你感到困惑。我怀疑他们会不断地与你讨论它，但实际上它只是你正在使用的词语。