细节取胜的javadoc

今个以为开发经验丰富的同事提出有个修改有问题，希望改一下，老前辈发话，心虚的紧，马上看了下，问题说是我的方法注释中写了一个

** doesn‘t **

建议改为

does not

说这个生成javadoc有问题，咦，不禁困惑，这个写法我记得没有违反javadoc的语法规则。

但前辈说了必然不虚，赶快查阅了ORACLE的javadoc文档

how to write docdocument for javadoc tool等几篇文章。似乎没说到这样有问题

然后用Android Studio写了example生成javadoc，still seems fine.

what’s wrong~

还是谨遵懿旨改了吧，事后再议，咳咳 毕竟是个有主见的yin.

恩恩

顺便说起javadoc，真是简单实用的工具，平时要求自己即使写小工程也要遵循javadoc写注释，只需要知道基本语法规则，即可在梳理和show others的时候使用，是非常值得推荐大家使用的，，具体的语法不在这讲了，毕竟so easy.主要使用核心还是要细致，对这些简单的按照规则即可应用的东西，最重要就是细致，细节决定一切。好比一个大家都很快写好的算法，代码的结构和命名规则都可以显示出素养和经验。

that’s all~

版权声明：本文为博主原创文章，未经博主允许不得转载。