[解決済み] PHPDocです。return void は必要ですか？

質問

本当にこのようなことをする必要があるのでしょうか？

/**
 * ...
 * 
 * @return void
 */

私は戻り値を持たないかなりの数のメソッドを持っており、コメントにこのような何かを置くことは本当に冗長に思えます。それを省くことは悪い形式とみなされるでしょうか？

どのように解決するのですか?

もしそれがドキュメントのために明確になるのであれば、そのままにしますが、厳密には必要ではありません。これは完全に主観的な判断です。

個人的には、私なら省きます。

EDIT

訂正します。少しググってみたところ wikipediaのページ に書いてあります。

return [type description] このタグは は使用しないでください。 を使用してはいけません。

phpdoc.orgのサイトにはこうあります。

@return データ型の説明

return datatype1|datatype2の説明文

returnタグは、関数やメソッドの戻り値を文書化するために使用されます。returns は他の自動ドキュメンターのタグ形式をサポートするための @return のエイリアスです。

データ型は有効な PHP 型でなければなりません。 (int, string, bool, etc), 返されるオブジェクトのタイプのクラス名, あるいは単に "mixed" であるべきです。複数の戻り値の型を明示的に示したい場合は、スペースを入れずにパイプで区切って列挙します (例 "@return int|string") 。クラス名が @return タグのデータ型として使用されている場合、phpDocumentor は自動的にそのクラスのドキュメントへのリンクを作成します。さらに、関数が複数の値を返す場合は | 文字で区切ると、 phpDocumentor は戻り値に含まれるクラス名を解析します。

そうですね... それを踏まえて、私はvoidを省くと言うことです。少なくとも、非標準的です。