Re: coding rules

[TSUCHIYA Masatoshi <tsuchiya@xxxxxxxxxxxxxxxxxxxxxxx>]

>> On Fri, 16 Nov 2001 08:14:09 +0900
>> 「山」== yamaoka@namazu.org (Katsumi Yamaoka) said as follows:

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

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

うわ。全部、私のスタイルと違う…。error で出力する文字列については、山
岡さんが直してくださっているのに気が付いて、ようやく学習しましたが、他
は気が付いていませんでした。

これは、ピリオドがないと文が完結しないからまずいのではないかなあ、と勝
手に思い込んでいたからなのですが、英語 native の人々が採用しているスタ
イルが正しいに決まっているので、今後はそれに従うようにします。


山> ファイルの冒頭の様式
山> 一行目のモジュール名と効能書きの間に入れるのは " --- "。

これは、Emacs Lisp Reference Manual の Library Headers に記述がありま
した。…と言うか日本語版の間違いを見つけてしまった。

en> The very first line should have this format:
en>   ;;; FILENAME --- DESCRIPTION

ja> 最初の行はつぎの形式であるべきです.
ja>   ;;; FILENAME -- DESCRIPTION

で、これまで私は、日本語版の記述に従っていたような気がします。直します。

この件に関して、前から疑問なのですが、この規則と -*- coding: ...; -*- 
はどのように両立させたら良いのでしょうね?


山> 二行目には一行目との間に空行を置かずに Copyright の表示。

これは状況依存だと思いますが、少なくとも Reference Manual の実例では空
行が挿入されています。個人的には、項目が別であることが明示されるように、
空行が入っているほうが好みです。

それと、Emacs21.1 の標準付属品を眺めると、空行を入れないのは、Gnus の
ローカルルールのような気がするのですが。


山> ファイルの最下行

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

これも私と逆ですが、Emacs の標準付属品を眺めると、空行が挿入されている
方が一般的なようなので従います。

;; って、これは、私の場合、機会があったら空行を削除する方向で修正して
;; ましたよ…。ついでに ends here の後ろにもピリオドつけてたな。


山> コメント行の semicolon の数
山> 通常は二つ。大項目でのみ三つ。

これはそうしているつもりなんですが…。あ、ひょっとして

    (w3m-buffer-setup)                  ; Setup buffer.

というようなスタイルはまずい?

;; と言うか、そもそもこのコメントは良くないな。完璧に無意味ではないで
;; すか。


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

これは知らなかった。そうするようにします。

;; あんまりにも引数が多くて、行末が80桁を越えてしまう場合、これまで引
;; 数リストをまとめて改行してしまってました。


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

これって、関数内部の話ですか?

そうか、大きなファイルの中で関数をグループ化する場合に2行空行を空ける、
というスタイルを私は使っていましたが、まずかったかなあ…。


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

いいえ、良いことだと思います。

-- 
土屋 雅稔  ( TSUCHIYA Masatoshi )