プログラミングコード コメントの必要性
何か最近のコメントに対する事柄を検索すると、コメントは基本書かない!見たいな記事をよく見ます。
これは間違いです!
コメントは1行単位で「後で最適化する」とか言うコメントはいりません!
コメントはコードの最初に書きましょう。
PHPのコードを例に下記に記します。
<?php
/*
入力チェッククラス
新規作成者 〇〇 〇〇
新規作成日時 20xx/xx/xx
機能一覧
1.NULLチェック
common_check_func->string_define
2.文字数チェック
common_check_func->string_length
3.数値チェック
common_check_func->string_numeric
4.メールアドレスチェック
common_check_func->string_mail
5.日付存在チェック
common_check_func->string_MyCheckDate
6.過去日付チェック
common_check_func->string_MyCheckDate_old
7.日付比較チェック
common_check_func->string_MyCheckDate_diff
更新履歴
例) 2006-07-20 ○○部に機能追加 LINE-117
*/
というように、コードの冒頭に、そのソースコードが何を書いてるのかを記します。
そしてバグがあった際の更新履歴は付けましょう。
いついつにコードの処理が遅かった為 何行目を修正等です。
これは結構過去に作ったクラスファイル
0