DeckとSliDeckで公開しました。このスライドは概要とメリットについてざっくり説明し理解と学習の動機を作ることを目的としていますが、これは日本ないし中国の大学ではコメントについてそこまで扱わないらしい*1という前提に基づいたものです。ここに記載のない発展的な内容としては以下が挙げられますが、これらについて学ぶのはまず手を動かした後で良いと考えています。よるパッケージに対するドキュメンテーションコメントMavenでjavadocを出荷する方法@Documentedアノテーションとは何で、いつ必要なのかコード内コメント以外のドキュメント(README、コミットコメント、バグトラッカー、プルリクエスト等)の使い方、使い分けプレゼン後に「publicでないクラスやメソッドにJavadocを書くべきか?」という質問を受けましたが、私の答えは「書くべき」です。自分自身の理解を深め、備忘にもなり、将来のメンテナンスも助けてくれます。直感的でないコードがあるならば、時間を取って書きたいです。Specではなく、内部実装方針や歴史的経緯等になるかもしれませんので、Javadocを書くべきというよりは開発者向けドキュメントを書くべきと言うべきなのかもしれません。contributionの良い題材になるとも話しました。typo修正くらいなら敷居は低いですし、多くのOSSでは喜ばれるはずです。GitHubなお自分のJavadocに関する理解は、Oracle公式ドキュメントに加えて「エンジニアのためのJavadoc再入門講座」に依るところが多いです。英語の解説書でこのくらい幅広く丁寧に説明したものが欲しい......。Calendarの25日目の記事です。昨日の記事はn...2013-06-12処理の流れに関連したFindBugsプラグインを作る端午节3連休中に調べたことのメモ。