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件
バッドをするには、ログインかつ
こちらの条件を満たす必要があります。