Re: 関数の doc-string の "*"

[Hideyuki SHIRAI ( 白井秀行 ) <shirai@xxxxxxxxxxxxxxxxxxx>]

From: TSUCHIYA Masatoshi <tsuchiya@pine.kuee.kyoto-u.ac.jp> さん曰く
Subject: [emacs-w3m:00777] Re: 関数の doc-string の "*" (was: cvs commit: emacs-w3m ChangeLog w3m-dtree.el w3m.el)
Message-ID: <20010516105624P.1000@pine.kuee.kyoto-u.ac.jp>
Date: 16 May 2001 10:56:23 +0900

白井> 最初、また、わけのわからん英語を直して貰ったのかと思ったら、
白井> doc-string の最初を "*" ではじめるのですね。こういう関数(ユーザ
白井> インターフェースな関数)の doc-string を "*" ではじめるのって、どっ
白井> かにのっていましたっけ？

土> 私の勘違いでした。説明文字列先頭に * を置く、という慣行の対象になるの
土> は defvar だけだったのですね…。というわけで全面的に修正しておきました。

いや、まぁ、良かった、良かったということで。:-)

土> 疑問その1

土>     defcustom はどうなるんでしょうか?

正確には知らないですが、elisp.info の Customization types に

     (defcustom diff-command "diff"
       "*The command to use to run diff."
       :type '(string)
       :group 'diff)

という例がのっているので、defvar と同じと考えて良いんじゃないで
しょうか。ま、もともと custom な変数はユーザ変数ですけど。

土> 疑問その2

土>     あるプログラム・モジュールの中で利用されることを想定した内部関数と、
土>     そのモジュールに対する API として利用されることを想定した関数を簡
土>     単に見分けるための適切な慣行は?

う〜ん、知りません :-)

# mhc で使った '/' が入っていたら内部関数、は良いアイデアだと思
# います。

土> # 実は、後者のつもりで * を使っていました…。

## じゃないかと思っていました。^^;;
## 別に Local rule でこれを適用しても良いかもしれないです。

-- 
白井秀行 (mailto:shirai@rdmg.mgcs.mei.co.jp)