product.el

[Shun-ichi GOTO]

>>>>> at Thu, 28 Dec 2000 10:52:54 +0900 (JST)
>>>>> handa == Kenichi Handa <handa ＠ etl.go.jp> said,

handa> 確かに product.el 自体を debug している時には doc-string が
handa> あった方が便利ですしね。でも、現在のところ doc-string で
handa> internal なものと API となるものの区別を付けるコンベンション
handa> はないので、我々で決めてしまっても良いかと思います。

その手のコンベンションが決まっていないのも不思議ですよね。

ちなみに public / private を明確にするという点では、いくつかのパッケージ
は、パッケージ名に続いて2つのハイフンを使用する事でを表現しているものが
ありますよね。このやりかたは結構昔から耳に/目にしているのですが、浸透し
ているわけでもないですね。またpublic <=> private の以降は別のシンボルと
なる点は少々問題アリなのですが、program source 上で明確になる点は魅力が
あるのも確かです。手元にないのであやふやですが、書籍『GNU Emacs 拡張ガイ
ド』でも、その流儀を挙げていた思います。

例: product-parse-version-string
    => product--parse-version-string


handa> internal なものは全部
handa>   "For internal use only.
handa> ...."
handa> という形にするのも良いかもしれません。
handa> 	M-x apropos RET ^product- RET
handa> で何が internal で何が API かすぐに分かるので。

Doc string に入れるのはとても良い事で、習慣にすべきのように思えます。ダ
ブルハイフンのような名称による方法よりも影響が少なく、効果も高いと思われ
るので。

ちなみに上のダブルハイフンのような場合も、"--" によって並び順が代わるの
でapropos での閲覧時にも効果はあるとは思います。

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