新しい会社に入社して一番最初に担当することになった仕事が、外注さんの作った管理ツールの検証と
機能追加だったんですが、ソースを見て愕然としました。
「なんじゃこりゃ･･･。」
なんの気遣いも感じられないソースだった。
インデントがそろってなかったり、無駄にスペース入れてあったり、逆にまったく入ってなかったり。
開発がひと段落しても、必要ないコメント(テスト用のコードとかデバッグコードとか)部分とか消してないし、使ってなさそうなファイルとかもそのまま放置。
こんなので金取るのか？って言うくらいひどいソースでした。
で、なぜ今回タイトルのような記事を書こうと思ったかというと、
自分が書いたソースで、そんな印象を受けさせたくない。
せめて、可読性だけでもきちんと保てるようにプログラムを書いていこうと思ったからだ。
絶対にやらないと決めたことを以下に示す。
PHP編
1.PHPのコーディング規約をなるべく守る。
2.変数名は適当に決めない。($keyとか$valueとか$val1、$val2等)
HTMLコーディング編
1.idやname属性等の情報もきちんとHTMLコーディング規約に則った形で決める。
(同一HTMLファイル内に同一のname属性を持たないようにする等の基本中の基本)
2.FirefoxのHTML Validatorでエラーがある状態のHTMLは完成しているとは言えない。
(HTML単体の場合のみ。PHPなどの出力が混ざってきた場合はよしとする)
3.JavascriptをHTMLソース内にベタ書きでは書かない。
(例外としてごくわずかな量のJSであればありとする)
4.CSSをHTMLソース内にベタ書きでは書かない。
(例外としてごくわずかな量のスタイルであればありとする)
