コード内コメントとJavadocの書き方 - Kengo's blog
社内勉強会向けに作成したコード内コメントとJavadocの書き方についてのスライドを、Speaker DeckとSliDeckで公開しました。 このスライドは概要とメリットについてざっくり説明し理解と学習の動機を作ることを目的としていますが、これは日本ないし中国の大学ではコメントについてそこまで扱わないらしい*1という前提に基づいたものです。 ここに記載のない発展的な内容としては以下が挙げられますが、これらについて学ぶのはまず手を動かした後で良いと考えています。 API Specとは何か、何を書くことが望ましいのか（読み手目線に立った考え方） package-info.java によるパッケージに対するドキュメンテーションコメント Mavenでjavadocを出荷する方法 ＠Documentedアノテーションとは何で、いつ必要なのか コード内コメント以外のドキュメント（README、コミッ
How to Write Doc Comments for the Javadoc(TM) Tool
Javadoc Home Page This document describes the style guide, tag and image conventions we use in documentation comments for Java programs written at Java Software, Oracle. It does not rehash related material covered elsewhere: For reference material on Javadoc tags, see the Javadoc reference pages. For the required semantic content of documentation comments, see Requirements for Writing Java API Spe
Requirements for Writing Java API Specifications
Requirements for Writing Java API Specifications 1 This document describes the requirements for writing API specifications for the Java platform. The specification for each Java TM platform API library is made up of its Javadoc comments and additional support documentation called out in the doc comments. This document has five sections that correspond to the sections of an API specification; each
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
