代码文档编辑器

Question

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

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

谢谢!

Answer 1

如果你说的是Visual Studio...

我已经编写了一个插件AtomineerUtils Pro Documentation，它将在文档创建和编辑方面提供很大帮助。

• 要创建注释，外接程序将尽可能多地使用您正在记录的代码元素中的信息来为您填充框架文档注释。它努力以可读的英文形式提供有用的信息(所以试图生成有意义的文档，并记录许多从代码本身看并不“明显”的东西，比如方法抛出的异常)
• 更新注释它可以将注释与代码同步-因此，如果你添加/删除/重命名参数，更改抛出的异常等，它将更新注释以准确反映代码的新状态documenting.
• It应用可配置的换行、空格控制和块格式化来帮助保持注释块的整洁。格式良好且一致。
• 它支持大量语言(C++、C、C++/CLI、C#、Java、VB)、Xml文档、Doxygen、Qt和JavaDoc文档格式样式、

如果你想要一个文档系统，在不接近源代码的情况下提供所见即所得的文档编辑，那么我相信像Document!X这样的东西可能更适合你的需求(我相信你必须自己编写所有的文档，但它的目标更多是创作外部文档，而不是提供代码内文档)。

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

Answer 2

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

问题是代码(和注释)在版本控制中，需要跟踪。你不能绕过它。

值得注意的是，您看到了编辑代码和注释之间的逻辑差异，但您编辑的是相同的文件。程序员看不到这些东西之间的区别，并且会被你的术语搞糊涂。我怀疑他们也会不断地和你争论，但实际上这只是你使用的词语。