代码之家  ›  专栏  ›  技术社区  ›  Pete

对于C#,除了xml文档注释之外,还有什么好的替代方法吗?

  •  5
  • Pete  · 技术社区  · 15 年前

    我找到了C#或VB的xml文档注释。NET很难阅读。有没有一个合适的替代方案(它仍然提供了为intellisense、文档生成等编写代码的好处)?

    4 回复  |  直到 15 年前
        1
  •  1
  •   cori    15 年前

    如果可读性是您试图解决的问题(例如,阅读XML会让您的眼睛抖动,这是我的问题),那么您可以向XML注释文件添加样式表。我从中引用的那个开始 this old post 并从那里修改。每次构建时都必须将其添加回去,但当您记录更改以供以后参考(即在活动开发期间不经常使用文档)时,情况还不错。

    我也使用 GhostDoc 以减少文档编制的时间。

        2
  •  0
  •   James Bailey    15 年前

    VisualStudio的Intellisense只读取XML文档。任何其他方法最终都会为您生成它,并且会过时,除非您始终保持同步。

        3
  •  0
  •   Doug L.    15 年前

    cr_documentor 这是另一种选择。您可以使用标准的xml文档(这样intellisnese和其他文档实用程序就可以放心了)。人类可读的文档在窗口中呈现(固定或浮动)。

    这可能不是你想要的,但你可以看看。

        4
  •  0
  •   albert    6 年前

    可以试试 doxygen .除了有一个令人耳目一新的名称外,它还有一个更轻的语法。有一些文档生成工具,它声称支持C#。