気に入った記事をブックマーク
- 気に入った記事を保存できます
保存した記事の一覧は、はてなブックマークで確認・編集ができます
- 記事を読んだ感想やメモを書き残せます
- 非公開でブックマークすることもできます
コード内コメントとJavadocの書き方 - Kengo's blog
7 users
blog.kengo-toda.jp
blog.kengo-toda.jp
blog.kengo-toda.jp
注目コメント算出アルゴリズムの一部にLINEヤフー株式会社の「建設的コメント順位付けモデルAPI」を使用しています
社内勉強会向けに作成したコード内コメントとJavadocの書き方についてのスライドを、Speaker DeckとSliD... 社内勉強会向けに作成したコード内コメントとJavadocの書き方についてのスライドを、Speaker DeckとSliDeckで公開しました。 このスライドは概要とメリットについてざっくり説明し理解と学習の動機を作ることを目的としていますが、これは日本ないし中国の大学ではコメントについてそこまで扱わないらしい*1という前提に基づいたものです。 ここに記載のない発展的な内容としては以下が挙げられますが、これらについて学ぶのはまず手を動かした後で良いと考えています。 API Specとは何か、何を書くことが望ましいのか（読み手目線に立った考え方） package-info.java によるパッケージに対するドキュメンテーションコメント Mavenでjavadocを出荷する方法 ＠Documentedアノテーションとは何で、いつ必要なのか コード内コメント以外のドキュメント（README、コミッ
blog.kengo-toda.jp
blog.kengo-toda.jp
blog.kengo-toda.jp
blog.kengo-toda.jp
www.phileweb.com
www.ktv.jp
gendai.media
togetter.com
quoitworks.com
zenn.dev/nakasyou
togetter.com
techblog.enechain.com
smhn.info
web.archive.org
zenn.dev/catatsuy
blog.kengo-toda.jp
blog.kengo-toda.jp
blog.kengo-toda.jp
2016/04/18 リンク