コーディングルール策定途中

2006年12月12日(火曜日) 23:27 JST 投稿者: Lily コーディングルール策定、はっきり言って面倒です。 参考にした資料によると、ルールは大きくわけて次の４つに分類されます。 1. 信頼性のために守るべき規則 2. 保守性のために守るべき規則 3. 移植性のために守るべき規則 4. 効率性のために守るべき規則 その中で、俗にコーディングスタイルと呼ばれるものは２に属します。 （１に属すものも含めている場合があります） 特にプログラマの習熟度と関係なく、単に「好み」のレベルの物を合わせておくという意味で、「見た目の統一」「命名規則」は重要かと思います。 >> 続く さて、参考資料に書いてある内容のうち、○印が付いているものだけを文章にまとめていて、思ったわけです。。。 自分がいきなりこれを見せられたら、 「えーーー、こんなの読まなきゃいけないの？？」 「こんなにあったら覚えきれないよ！！」 と絶対思います。 少なくとも「見た目の統一」に関しては、文章の羅列を読めというのは不親切です。 サンプルのソースコードを見て真似すればOKにして欲しい。 （曖昧にならないように文章化されたものもあった方がいい） それから、ルールは幾つかの段階に分けられるのではないかと思います。 1. 上級者でも人によってマチマチなルール 　1.1 文章で説明されないと分からない 　1.2 サンプルソース見れば「ああ、そうするのね」と分かる 2. 上級者でも言っておいた方がいいルール 3. 上級者なら守るだろうというルール 4. 中級者には言っておかなきゃならないルール 5. 初級者には言っておかなきゃならないルール たぶん、4と5はサンプルを示しつつ、文章でも示す必要があります。 でも、これを記述するとルールが多くなりすぎるので、「勉強しておいて」で済ませたいところです。 つまりルールとは別の「参考書」としてあるべきかと思います。 どこを中級と上級の境目にするかは非常に難しいですが・・・。 それから、１、２をまとめた文書Aと、３をまとめた文書Bは別に分けておきます。 すると上級者はAだけを見てプログラミングを開始できます。 ソースコードレビューなどで間違っていることに気付いたら、指摘してBに従ってもらうようにします。 というわけで、改善点は以下。 1. できるだけ直感的にわかりやすく 2. 「ルール」と「スキル」を分離してルールを出来る限り減らす 3. 伝える優先度を段階的にしておく

トラックバック

このエントリのトラックバックURL: http://bluetooth.k5-n.com/trackback.php?id=20061212232743936

コーディングルール策定途中 | 0 件のコメント | アカウントの作成

古い順に 新しい順に 表示しない ツリー 入れ子 一覧

コメントは投稿者の責任においてなされるものであり、サイト管理者は責任を負いません。