Android Studio 特别好用极其重要的一个星号注释法,你Get到了没?
程序员文章站
2022-06-09 13:31:18
...
以前我们看许多Android的源码,里面很多代码的注释都用的是下面的方式,看着非常多行,要是让我自己输入这些,我肯定不干。
我最常用的也就是单行代码注释法:“//”。这样一目了然,太方便了。
/**
*
* @param data
*/
可最近,我在查看Android源码的时候,发现一个问题,我们在点击Android源码里的函数的时候,鼠标下出现的帮助都是有注释的。而当我点击自己的用“//”注释的函数时,却没有详细的帮助,甚至是没有帮助注释,问题是,我明明已经注释的了。那么问题在哪呢?
很明显,注释方式不一样。那么我改成了Android源码一样的注释方式,也就是上面的星号注释法。结果我定义的那么函数的注释也都出现在的帮助文档里了。
这个帮助对于后面维护老实说真的很重要,做过些程序或者写过些代码的人都知道,当你想要翻看以前的代码时,没有注释,你就需要重新读一遍代码,简单还好说,复杂的话,你甚至还需要花费大量的时间去理解去剖析去回忆当时的思路,这是很痛苦的一件事,明明代码时自己写的,结果现在忘了个干净。所以这个注释太重要了。
那么如果我们自己手动输入这些个星号,说实话,很烦的,尤其是天天那么多函数,类,变量啥的,这些星号无疑大大地增加了我们的工作量,所以我们不值得这么做。实际上,Android Studio里面对这个注释法已经有了很好的支持,那就是,只要你把函数声明写完,然后输入“ /** ”,回车,就可以看到上面的这种注释了。
上一篇: easyexcel2.0工具类