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

coding rules 

.el ファイルの書き方で気になることがあります。

これがどこで規定されているのか (またはされていないのか) 調べてい
ないのですが、例えば Gnus では以下のようなルールが使われていて、
ときどき大掃除が行なわれます。


以下の文字列は、最後に "." を付けない。

  ファイル一行目のモジュールの効能書き。
  ファイル最下行の "ends here"
  message や error で出力する文字列。

ファイルの冒頭の様式

  一行目のモジュール名と効能書きの間に入れるのは " --- "。
  二行目には一行目との間に空行を置かずに Copyright の表示。

ファイルの最下行

  "***.el ends here" の前に一つの空行。

コメント行の semicolon の数

  通常は二つ。大項目でのみ三つ。

関数とその引数

  関数と同じ行に、最低一個は引数を書くようにする (なるべく)。

その他

  二つ以上連続した空行は、特別な場合を除いて使わない。


とまあ、要するに現在の emacs-w3m に対するいちゃもんなのですが、
私の望み (一般的な書き方にすること) は無理な要求でしょうか?

;; 実は機会がある毎に書き換えていたりしますが。:-p
-- 
Katsumi Yamaoka <yamaoka@namazu.org>