用于编辑XML代码注释的工具更有效率?

时间:2012-06-27 10:08:49

标签: c# .net visual-studio-2010 xml-comments

我正在寻找有助于更有效地编辑和管理优秀XML代码注释的工具,因为当我想编写更精细的注释(带有项目符号列表,表格和表格)时,Visual Studio中的编辑工具似乎无法扩展。更长的解释)。更具体地说:

  • 在代码中很好地格式化xml注释(包装,自动xml格式化文本缩进等)
  • WYSIWYG编辑器,用于更高级的编辑(项目符号列表,表格等)
  • 预览和输出生成
  • 详细了解记录的内容和内容,以及比查看单个文件更高级别的内容。

2 个答案:

答案 0 :(得分:2)

我是Atomineer Pro Documentation插件的作者,值得一看。它更多地关注源代码而不是外部生成的文档,因此它可能是也可能不是满足您需求的正确工具,但这里有一个关于它如何与您的特定需求列表相关的要点:

优点:它可以帮助您比大多数(如果不是全部)其他插件更快更好地生成原始注释,并支持比其他插件更多的源代码语言和注释格式。更新注释时,它将比其他插件更进一步,使您可以控制格式(注释内部和外部的空格控制,注释块格式,对自动换行的非常好的控制,条目格式,缩进和块分隔符行,并支持项目符号列表等)。它还包括一个文档查看器窗口,允许您查看最终文档的外观(取决于您将其导出为富文本格式的方式)。实时打字辅助工具可以更快,更轻松地编辑文档评论。

缺点:它(尚未)提供文档的富文本编辑,也不提供解决方案的文档概述。您可能会发现DocumentX这样的产品可能会更好地满足您在此领域的需求。

答案 1 :(得分:0)

我最近发现这个GhostDoc我正在考虑使用它来帮助XML注释。