タグ

関連タグで絞り込む (1)

タグの絞り込みを解除

javadocに関するhikazohのブックマーク (1)

  • 日本語でのJavaDocの書き方 - 水まんじゅう2

    JavaDocを何で書くの?とか、書き方とかをまとめたページはたくさんありますが、日語特有の情報が抜け落ちていたり、英語でのJavaDocの書き方を説明するものばかりなので、日語特有の情報をいくつか書きたいと思います。 なお、JDK 8u144あたりでの挙動です。将来では変わるかもしれません。 JavaDocの書き方の一般的なものを知りたい場合は公式のマニュアルを見るのが一番良いと思います。 https://docs.oracle.com/javase/jp/8/docs/technotes/tools/windows/javadoc.html サマリー文の後は2つ改行を入れましょう。 /** * 一行目はサマリー文としてその処理(クラス、メソッド等)の概要として扱われます。 * * <p>英語では行末に「.」(ピリオド)が入り、JavaDocではピリオドまでを1行目のサマリーとして扱

    日本語でのJavaDocの書き方 - 水まんじゅう2
  • 1