有没有比C#的XML文档注释更好的替代方案？

Question

5

我发现C#或VB.NET的xml文档注释很难阅读。有没有一个不错的替代方案（仍然提供为智能感知、文档生成等记录代码的好处）？

- Pete

4个回答

0

Visual Studio的Intellisense只能读取XML文档。任何其他方法都会为您生成它，并且除非您在保持同步方面始终如一，否则它将变得过时。

- James Bailey

0

你可以试试 doxygen。除了名字很有趣外，它的语法也比较简洁。它还有文档生成工具，并声称支持C#。

- Ryu

0

cr_documentor 是另一个选择。您可以使用标准的 XML 文档（因此 IntelliSense 和其他文档实用程序会保持良好）。人类可读的文档将在窗口中呈现（停靠或浮动）。

它可能不完全符合您的要求，但您可以看一下它。

- Doug L.

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- cori · Accepted Answer

如果可读性是您要解决的问题（即阅读XML使您的眼睛晃动，这也是我的情况），则可以向xml注释文件添加样式表。我从this old post引用的样式表开始，并进行了修改。每次构建时都必须将其添加回去，但是当您为以后的参考记录更改时（即在活动开发期间不经常使用文档）它并不太糟糕。

我还使用GhostDoc使文档编写变得更加省时。