我的同事很少(如果曾经)在使用我们的软件时使用XML注释(我不能说我没有更好).我最近看到了使用它们的好处,但如果他们记录的代码写得清楚(表达/描述变量/函数名称,一些内联评论),它们真的值得吗?
谢谢!
XML注释对于生成文档很有用.如果代码写得清楚,那么您不需要注释来帮助您理解代码.
但是,文档注释对于类的用户是有用的,因为它(应该)包含类或方法功能的描述,而不是代码的描述.