当前位置:  开发笔记 > Android > 正文

XML注释:使用或不使用?

如何解决《XML注释:使用或不使用?》经验,为你挑选了1个好方法。
如何解决《XML注释:使用或不使用?》经验,为你挑选了1个好方法。

我的同事很少(如果曾经)在使用我们的软件时使用XML注释(我不能说我没有更好).我最近看到了使用它们的好处,但如果他们记录的代码写得清楚(表达/描述变量/函数名称,一些内联评论),它们真的值得吗?

谢谢!



1> Megacan..:

XML注释对于生成文档很有用.如果代码写得清楚,那么您不需要注释来帮助您理解代码.

但是,文档注释对于类的用户是有用的,因为它(应该)包含类或方法功能的描述,而不是代码的描述.

推荐阅读
手机用户2402851335
这个屌丝很懒,什么也没留下!
DevBox开发工具箱 | 专业的在线开发工具网站    京公网安备 11010802040832号  |  京ICP备19059560号-6
Copyright © 1998 - 2020 DevBox.CN. All Rights Reserved devBox.cn 开发工具箱 版权所有