PHPファイルのコメント文について

質問

現在PHPを勉強しながらwebサイトを作成中なのですが、PHPファイル内のコメントの扱いついて悩んでいます。
サイトオープン後のメンテナンスやデバッグがしやすいようにとかなり詳細にコメントをつけているのですが、先日「余りに多いかな」と感じて、コメントを全てとったものを作成しコメント付きのものと比較したところ、平均して30％～40％くらいファイルサイズが小さくなりました。処理速度は平均して5％くらいしか変わらないのですが、サーバ（共用のレンタルサーバ）になにか不具合があったときなどはコメントなどつけないほうが少しでも安全な気もします。
アフターを考えればコメントは詳細につけるべき、処理速度とセキュリティを考えるならコメントは最小限にするもしくはつけぬべき、とどうすべきなのか悩んでいます。
「こうすべき」というようなものはないとは思いますが、皆さんはどのようになさっていますか？ご教授いただければ幸いです。

回答No.2

hide1978 · ベストアンサー

> コメントなどつけないほうが少しでも安全な気も...
yambejpさんも仰っていますがセキュリティは関係ないと思います。

> 平均して30％～40％くらいファイルサイズが小さくなりました。
ファイルサイズは小さい方が良いのは当然ですが、コメントが無いことでコードの可読性が低下してしまっては本末転倒です。ですので必要最低限のコメントはコードに埋め込んでも良いと思います。

どうしても長いコメントが必要になる場合には、yambejpさんのアドバイスにもあるように、ファイルをサーバにアップする際にフィルタリングを掛けてコメント部分を削除するのが良いでしょう。

フィルタリングの方法が解らない、もしくは面倒だ・・・という場合には、詳細なコメントだけを集めたテキストファイルを別途用意するという方法もあります。

たとえば
/*
* 関数名：hogehoge
* 詳細：コメント.txtのhogehogeを参照
* @param string 変換対象文字列
* @return string 変換処理後文字列
*/
public function hogehoge ( $val ) {
/* 処理 */
return $val;
}
といったコメント付きの関数を定義した場合、別途「コメント.txt」というファイルを用意しておいて、その中にhogehogeという関数に関する詳細を書く。

この方法なら、コード中には必要最低限のコメントを記述するだけで済みますし、必要な場合には「コメント.txt」を開くことで関数の詳細を確認することも可能となります。

お礼

なるほど、別にテキストファイルにて履歴も含めてコメント管理しておけば手間でも逆に管理しやすそうですね。
参考にさせていただきます。
有難うございました。

回答No.1

yambejp

＞処理速度とセキュリティを考えるならコメントは最小限

セキュリティは関係ないのでは？
処理速度は気にする程度ではないと思いますが、最低限にしてもいいかも
しれませんね。
場合によってはアップするファイルをフィルタしてコメントを
とってしまうとか、やりようはあるでしょう

お礼

そうなんですか。
いえ、サーバに不具合があったときなどにPHPファイルそのものが流出してしまうと思っていたものですから、その際必要以上に可読性が高いと逆に悪用される率が高まるのかな？　と漠然と考えていました。
そのあたりに問題が無いのであれば分かり易いに越したことないですね。
有難うございました。