[seasar-javadoc:103] Re: ツッコミ大歓迎! 叩き台サンプル

[Koichi Kobayashi]

小林 (koichik) です．

Date:    Tue, 30 May 2006 01:42:45 +0900
From:    Hideaki Suzuki <suzuki ＠ uinet.or.jp>
To:      seasar-javadoc ＠ ml.seasar.org
Subject: [seasar-javadoc:101] Re: ツッコミ大歓迎! 叩き台サンプル

> eclipseのフォーマット定義を変えれば直るんでしょうか？(未調査)
> 動きを見ていると、１行の最大長の設定が長めのような雰囲気です。

1 行のバイト数あるいは表示幅 (って何？) で設定できると
いいのですが，文字数で設定するしかないのでちょっと
難しいです．
Javadoc に合わせると 1 行 50 文字程度に設定しないと
いけなくて，それだどコードが苦しくなると言う．．．
Javadoc を読むのは主にソース上じゃなくて HTML なので，
ココは割り切りましょう．

> …というかルール([seasar-javadoc:17] Re: ガイドライン)でしたね…
> 記述中はWikiしか見ていませんでした(^^;;;;;

Wiki にも

> 英数は1byte文字で。2bytes文字との間に空白を入れない。

と昔から書いてありますよ．(^^;

> ・負荷分散
> Javadoc Wiki に記載されていないルールの追加などは、気づいた人が
> Wikiに書いてから、このMLに『Wikiにこんなの書きました』メールを
> 流すようにすれば、【見覚え】koichik【あります】さんの負荷が減る
> かなぁと思うのですが、皆さんいかがでしょう？
> ※ Javadoc Wiki は気軽に書き加えても良さそうな雰囲気ですし。

是非お願いします．

> ▼-----------------------------------------------------------
> リテラル　【literal】
> 読み方 ：  リテラル 
> 　プログラムのソースコード中に使用される定数のこと。「255」「fujiyama」
> など、いわゆる単なる数字や文字列がリテラルの代表例である。
> プログラミング言語は、リテラルの型を確実に判別するために(文字が書いて
> あるときは文字列か変数か区別する必要もある)、コード中にリテラルを指定する
> ときに特定の書式を要求する。例えば、文字列を表記する際は必ず前後を「"」で
> 括る、と定めている処理系が多い。このため、プログラミングに関する文章では
> 必要に応じてリテラルを型ごとに分類し、「数値リテラル」「日付リテラル」など
> と呼び分けるのが一般的である。対義語は「変数」。
> -----------------------------------------------------------▲

リテラルの定義としては外れてないと思います．
ただ，『対義語が「変数」』はちょっとどうかと．

int n = 10;

の n は変数で 10 はリテラル．

private static final double PI = 3.14

PI は定数ではあってもリテラルではなく，3.14 はリテラル．

> 1. <code>Bean</code>、<code>getter</code>、<code>setter</code>
>    >>> 「リテラル」をIT辞書で引く
>    >>> フム、ってことはリテラルではないな

うん，リテラルではないでオッケー．

> 識別子と定数については、迷いませんが、「キーワード」は、
> ちょっと完全には規約化できなさそうですね。

キーワードとは Java 言語における予約語のことなので
完全に規約化できます．
よく使うのは null，true，false．
これらについては <code>〜</code> しませう．

> P.S.
> ひょっとして、私、プロジェクトを本筋から逸らせてません？
> 逸らせてたら遠慮なく言って下さい。
> 「細かいこと気にせず、とりあえずやりゃぁいいんだYo!」とか (^^;;;

いえ，なんかプロジェクトが動き出した感が出てきたので
いいんじゃないでしょうか．


-- 
<signature>
    <name>Koichi Kobayashi</name>
    <e-mail>koichik ＠ improvement.jp</e-mail>
</signature>