【PHP】PHPフレームワーク総合スレ15
■ このスレッドは過去ログ倉庫に格納されています
0787nobodyさん
2013/08/11(日) NY:AN:NY.ANID:???長文になる時は別の書き方を用意すればいいだけの話。
// 関数と戻り値のコメントを書く。
// [*1] : 長いコメント
// [*2] : 長いコメント
function Hoge getHoge(
int value, // 短いコメント [*1]
string str, // 短いコメント [*2]
) {
・・・
}
重要なのは、コードを変更した時、同じ事を二度やらなければいけないということ。
コードとドキュメントの整合性が取れなくなるのは、これが理由。
■ このスレッドは過去ログ倉庫に格納されています