[Date Prev][Date Next][Thread Prev][][Date Index][Thread Index]

Re: 関数の doc-string の "*" (was: cvs commit: emacs-w3m ChangeLogw3m-dtree.el w3m.el) 

>> On Tue, 15 May 2001 21:07:10 +0900 (JST)
>> 「白井」== shirai@rdmg.mgcs.mei.co.jp (Hideyuki SHIRAI (白井秀行)) said as follows:

白井> ## 恥を忍んで聞いてしまいますが。。。

いえ、恥を忍ばなければならないのは私の方です。


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

すみません、すみません、すみません。

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


疑問その1

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


疑問その2

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


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

-- 
土屋 雅稔  ( TSUCHIYA Masatoshi )
    http://www-nagao.kuee.kyoto-u.ac.jp/member/tsuchiya/