2

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

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

谢谢！

4

2 回答 2

2

如果你在谈论 Visual Studio...

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

  • 为了创建注释，插件使用您正在记录的代码元素中的尽可能多的信息来为您填写框架文档注释。它努力以可读的英文形式提供有用的信息（因此尝试生成有意义的文档，并记录许多从代码本身无法立即“明显”的东西，例如方法抛出的异常）

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

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

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

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

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

于 2011-10-05T21:56:40.280 回答
1

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

问题是代码（和注释）在版本控制中，需要跟踪。你无法绕过它。

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

于 2011-10-05T21:57:14.087 回答