javadoc 考
最近、Java でプログラミングすることが多くなった。Eclipse はすごいと思う。
で、Java と言えば javadoc (?) だが、これはこれで便利だ。少なからずともコメントの書き方を標準化したのは偉い。
ただ、書いていて思うのは、
/**
* ほげほげする。
* @param bar バー。
* @return バーをブーした値。
*/
public int foo(int bar) {
...
}
と書くわけだが、これで5行も行数を取ってしまうのは無駄だ。
/** ほげほげする。
* @param bar バー。
* @return バーをブーした値。
*/
とすると1行節約できるが、さらにもう1行節約しようとすると、
/** ほげほげする。
* @param bar バー。
* @return バーをブーした値。 */
になるが、これはカッコ悪すぎる。
狭いエディタの画面内で、画面を有効に使うためには、ぜひ行数を節約できるコメントの記述法にしたいところだ。