- 2005/01/16
- その他
今日は久々の休日出勤でした。昼過ぎには行くつもりだったのが、ごたごたしてて夕方になってしまったのですが・・・
作業内容はちょこっとプログラムの修正です。
その作業をしていて感じたのがソースの統一性のなさ…まちまちな修正を何度も加えているので読むだけで疲れるソースになってしまっています。
あと、htmlソースの書き方も力技でレイアウトを作っているようなそんな印象をうけるソースです。
自分で納得のいくように直したいというのが正直な気持ちです。htmlのコーディングに関して知識は少ないですが、そのぶんやりがいはあります。が、それだけ時間をかけていいのか?それと、途中で飽きないのか?の2つが理由でソースの書き直しはしていません。
ん~、こんなんでいいんでしょうか・・・
対応方法としては保守用のコーディング規約を作成し、これから保守をする際はこのコーディング規約を基に保守の対象箇所だけはなく、ソース全体を修正する。というのが私の考えです。この方法だとテストする手間が省けます。下が考えたものです。
コーディング規約(保守)
・ヘッダーの修正履歴などのレイアウトは統一する
・不要となった部分をコメントとして残している箇所は削除する
・インデントは必ず行う
・コメントが不足している箇所は補足する
・IF、EQなどは必ず大文字で
・変数の初期設定とメイン処理をわける
・変数の初期設定→いろいろ処理をする箇所→html箇所 の順で記述する(ソースの頭で処理を実行しないと意味のないものを除く)
・全体に共通する処理については、一覧としてまとめ全ソースで同一動作になるようにする
・コンポーネントの戻り値を統一する
・コンポーネントの戻り値をどう受け取るかを統一する(どのスコープで受け取るか)
・コンポーネントの処理の記述も統一する
・最後にコーディング規約は従うだけでなくより良いものになるようメンテする
こっちもどうぞ
- 新しい: 志し、信念をもちたい
- 古い: OUTER JOIN