细节取胜的javadoc
今個(gè)以為開(kāi)發(fā)經(jīng)驗(yàn)豐富的同事提出有個(gè)改動(dòng)有問(wèn)題,希望改一下。老前輩發(fā)話,心虛的緊,立即看了下,問(wèn)題說(shuō)是我的方法凝視中寫(xiě)了一個(gè)
** doesn't **建議改為
does not說(shuō)這個(gè)生成javadoc有問(wèn)題。咦。不禁困惑,這個(gè)寫(xiě)法我記得沒(méi)有違反javadoc的語(yǔ)法規(guī)則。
但前輩說(shuō)了必定不虛,趕快查閱了ORACLE的javadoc文檔
how to write docdocument for javadoc tool等幾篇文章。似乎沒(méi)講到這樣有問(wèn)題
然后用Android Studio寫(xiě)了example生成javadoc。still seems fine.
what’s wrong~
還是謹(jǐn)遵懿旨改了吧。事后再議,咳咳 畢竟是個(gè)有主見(jiàn)的yin.
恩恩
順便說(shuō)起javadoc。真是簡(jiǎn)單有用的工具,平時(shí)要求自己即使寫(xiě)小project也要遵循javadoc寫(xiě)凝視,僅僅須要知道基本的語(yǔ)法規(guī)則,就可以在梳理和show others的時(shí)候使用。是非常值得推薦大家使用的,,詳細(xì)的語(yǔ)法不在這講了。畢竟so easy.主要使用核心還是要仔細(xì),對(duì)這些簡(jiǎn)單的依照規(guī)則就可以應(yīng)用的東西,最重要就是仔細(xì),細(xì)節(jié)決定一切。好比一個(gè)大家都非常快寫(xiě)好的算法,代碼的結(jié)構(gòu)和命名規(guī)則都能夠顯示出素質(zhì)和經(jīng)驗(yàn)。
that’s all~
轉(zhuǎn)載于:https://www.cnblogs.com/wzzkaifa/p/7283473.html
總結(jié)
以上是生活随笔為你收集整理的细节取胜的javadoc的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇: Map类集合遍历
- 下一篇: 转载:FilenameUtils的工具类