c# - 对于 C#,是否有替代 xml 文档注释的好方法?

标签 c# coding-style

我发现 C# 或 VB.NET 的 xml 文档注释很难阅读。是否有合适的替代方案(仍然提供为智能感知、文档生成等记录代码的好处)?

最佳答案

如果可读性是您试图解决的问题(即阅读 XML 使您眼花缭乱,而我确实如此),您可以将样式表添加到 xml 注释文件中。我从 this old post 中引用的那个开始并从那里修改。每次构建时都必须将其添加回来,但是当您记录更改以供以后引用时(即在事件开发期间不经常使用文档),这还算不错。

我也用GhostDoc减少文档的耗时。

关于c# - 对于 C#,是否有替代 xml 文档注释的好方法?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/1669721/

相关文章:

c# - 急切的 Include 函数调用内存中的数据吗?

c# - ASP.NET 和 C# 中的验证

python - 表达或声明? :'if a : do_something()' 和 '(a and do_somthing())' 哪个更好?

php - 如何在sublime中使用phpcs来学习编码标准?

java - 如何处理未使用的@Override方法?

c# - 独立于平台的 protobuf 套接字协议(protocol)——我会收到什么消息?

c# - VS2022 - 输入问题

c# - 带动态元素的 WPF 启动屏幕。如何?

java - 在类的构造函数中完成类的主要工作有什么问题吗?

objective-c - 从逗号分隔文件加载类的最佳方法