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

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

たまには発言

そいえばこの話ってちょっと前にemacs-mime-ja 辺りでだったか、出ていたと思
うけどその際には、一般的な決まり事はとくに無い、といったことだったような。

>>>>> at Wed, 16 May 2001 11:07:52 +0900 (JST)
>>>>> 白井 == Hideyuki SHIRAI (白井秀行) <shirai@rdmg.mgcs.mei.co.jp> said,

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

他に
  * local 関数は prefix を大文字で始める
  * local 関数は prefix に続いてダブルハイフン"--" を用いる
  * local 関数と public 関数はprefix を違うものにする
  * local 関数は DOC string の1行目末尾に [internal] といった記述を加える。
  * local 関数は DOC string を書かない :-)

なんてのを見た覚えがあります。自分でも一時期ダブルハイフンを使って
そのように分けていた時期がありますが、そんなことよりも文書や.el file
をしっかり作ることの方が効果的だと感じました。(^^;


P.S.
user variable の "*" は、edit-options でリストアップするためにも
使われているので強い慣行として使われているのでしょうが、関数の 
スコープに関してはそれにそうとするものが無いですしねぇ。

山岡さんの inline 方式も究極で良いと思っているのですが、自分がやるとなる
と結構抵抗がある。

--- Regards,
 Shun-ichi Goto  <gotoh@taiyo.co.jp>
   R&D Group, TAIYO Corp., Tokyo, JAPAN