0
1
質問
PHPで個人開発しています。
なるべく慣習に従った構造を心がけたいのですが、大項目としてのコメントアウトにはこれといった構造がないように思うのですが…
以下の
// ====== Get Methods ======とか
// ====== Post Methods ======とか
みたいなコメントアウトです。
みなさんどのようにされていらっしゃいますか？
php
1class MyClass 2{ 3 // ====== Get Methods ====== 4 5 /** 6 * ここにgetAメソッドの説明を記述する 7 */ 8 public function getA(){} 9 10 /** 11 * ここにgetBメソッドの説明を記述する 12 */ 13 public function getB(){} 14 15 // ====== Post Methods ====== 16 17 /** 18 * ここにpostAメソッドの説明を記述する 19 */ 20 public function postA(){} 21 22 /** 23 * ここにpostBメソッドの説明を記述する 24 */ 25 public function postB(){} 26}
調査したこと
大項目でなければ次のリンクのように「PHP Documentorではこういう感じ」などのようなある程度の決まりがあるようですが…
【PHP入門】コメント・コメントアウトの使い方を解説
https://www.sejuku.net/blog/25940
php
1/** 2* 3* @package パッケージ名 4* @author 作成者 5* @since PHP7.1 6* @version プログラムのバージョン 7* 8*/
しかし大項目の場合ですと次のリンクのように多種多様なコメントがあるようで…
CSS,JavaScript,PHPで使えるコメントアウト装飾
http://www.ar-ch.org/mt/archives/2010/05/-cssjavascriptphp.html
php
1/* 2大ブロック 3———————————–*/ 4 5/*———————————– 6大ブロック 7———————————–*/ 8 9/*================================== 10大ブロック 11==================================*/
回答4件
#1
総合スコア684
投稿2023/06/03 10:53
何を目的としたコメントかどうかによりますし、
好みとエディタにもよると思います。
よくみるのはドキュメントコメントというものですね。
「PHPDoc コメント」で検索すると参考になると思います。
#2
総合スコア2022
投稿2023/06/03 11:50
編集2023/06/03 16:02フラットに書いてある各メソッドをグルーピングしたりラベル付けしたりするような記述方法がまだ発明されておらず、
// ====== Get Methods ======
というコメントはプログラムの挙動と直接リンクしない & 自動生成ドキュメントとの相性も悪いためそれほどの価値がない (せいぜいメモ程度)。よって統一的なルールも決められていない。結論としては好みでいいんじゃないでしょうか。
なお、クラスを分けたりインタフェース使ったりするほどのことではないが、ここから先は GET、ここからは POST という整理方法を書きたいという思いは理解できますので、そのうちよい記述方法が発明されるといいなとは思います。
#3
総合スコア85901
投稿2023/06/03 15:28
どういう観点で聞いているのでしょうか？
なるべく慣習に従った構造を心がけたいのですが、
しかし大項目の場合ですと次のリンクのように多種多様なコメントがあるようで…
一般的な慣習がなくて、多種多様であるという状況を理解した上で聞いているのであれば、
回答者の「自分はこういう理由でこうしている」という、たまたまこのページを見ている一個人の意見を聞きたいと言うことでしょうか？
（その理由に納得すれば自分も採用する？）
それとも、
なるべく慣習に従った
ということで、多数決を取りたい的な意図なのでしょうか？
後者であれば、すでに回答のあるように「好みで良いんじゃないの？（多数決とっても意味が無い）」と言うことになるかと思います。
前者であれば、質問文を書き直さないと、また後者前提の回答が付くと思います。
あと、「コメントアウト」とお書きの物は普通は「コメント」と言います。
「コメントアウト」というのは、「（コメントじゃない）コード部分にコメント記号を書き足してコメントに変える」と言う動作を意味します。サ変名詞（名詞のうち「する」をつけると動詞になる物）というやつですね。
例：「デバッグのために、一時的に15-20行目をコメントアウトする」（後でコードに戻すのが前提）
バッドをするには、ログインかつ
こちらの条件を満たす必要があります。