説明文書でのメソッド・変数の書き表し方

　プログラムの解説文書の書き方に関してお尋ねします。

　「A クラスの B メソッド」といった場合，プログラム中では
　　A.B()
とコールしますが，たとえば「String クラスの charAt メソッド」を説明的に示すのに，（プログラムの付属文書で）String#charAt() という表記を見かけました。
　この表記の根拠となっている文書・文献は何なのでしょうか。

　前記の表記と同様のもので，
　- クラスの通常のメソッド（これは String#CharAt() のようなもの）
　- 特定のインスタンスのメソッド
　- クラスのクラスメソッド
　- クラスのインスタンス変数
　- 特定のインスタンスのインスタンス変数
　- クラスのクラス変数
を書き分ける表記方法があるならば，ご教示ください。同時に根拠になっている文書・文献をお示しくださると幸いです。

No.1 ベストアンサー 回答者： okanah09 回答日時： 2005/09/13 00:45

JavaDocの表記方法?らしいのですが、参考URLを見てもはっきりしません。

参考URL：http://java-house.jp/ml/archive/j-h-b/018327.html

この回答への補足

　ご回答ありがとうございます。
　　http://java.sun.com/j2se/1.5.0/docs/tooldocs/win …
を見たら，ありました。軽く目を通したところ，クラスのメンバには何でもかんでも「#」をつけて参照しているようです。

　とすると，参考にお示しくださった中の，「static メンバは『.』」というのは何なのでしょうか。

補足日時：2005/09/13 13:45

この回答へのお礼

　決定的なことがわからなかったのは残念でしたが，「JavaDoc の表記法」という糸口はつかめました。
　ご回答くださった皆様に感謝します。

お礼日時：2005/09/21 19:31

No.3 回答者： deadlock 回答日時： 2005/09/13 20:32

私もちゃんとした情報源はないですが…

・JavaDocでは#で区切る
・クラス名、メソッド名(メンバ名)の区切り
・#はURIのフラグメント(フラグメントは、特定リソースの一部をあらわす)に対応している

として勝手に解釈していました。
Javaの仕組みでは、
・リソース(クラスのバイナリ情報)の取得はクラス単位
・各メンバはその後にVMなどに利用される
等の点から、URLのフラグメントに対応しているんだと思ってました。

この回答へのお礼

　JavaDoc では「#」で区切っていました。これは，No. 1 のご回答でもご教示いただきました。
　しかし，それ以上の確実なことがわからなかったのは残念です。

　ともあれ，ご回答ありがとうございました。

お礼日時：2005/10/07 14:39

No.2 回答者： love-less 回答日時： 2005/09/13 10:38

由来のわからない(わかりにくい)

業界標準ってのはけっこうあると思うので
多分そのひとつかなとおもってたんですが

とりあえず、htmlでページ内リンクに「＃」を使うこと
と
パッケージは.で区切っていき
一番右端のがクラス名になる（こともある）
と
.区切りでメソッドを書くと誤解を招く恐れがあるので
＃で区切ることでクラスとメソッドの区切りを明確にする

とかゆう話はきいたことありますが

この回答へのお礼

　JavaDoc に関わるものだということは No. 1 のご回答からわかりましたが，その詳細がご専門の方でもよくご存じでないというのは不思議です。

　ともあれ，ご回答ありがとうございました。

お礼日時：2005/10/07 14:35