3

クラスでデザインパターンが使用されている場合、クラスの上部または関連するメソッドの上部にあるコメントで、使用されている特定のデザインパターンまたは実際の機能を説明する必要があります。

すなわち

/**
 *  Class MyClass
 *
 * Utilizes Factory Method patter to accomplish xyz
 */

また

/**
 *  Class MyClass
 *
 *  Allows the creation of objects for xyz
 */

これは説明のために非常に単純化されています

私の質問の主な部分は、他の人がどのデザインパターンが使用されているのか疑問に思っているのか、それともどのデザインパターンが使用されているのかを言うだけで賢いお尻のように出くわすのかどうかです。

4

2 に答える 2

3

一般的な方法は、クラス（つまり、XyzFactory）に名前を付けることです。これにより、使用するパターンを簡単に確認し、コメントで実際の機能を示すことができます。できれば、デザインパターンがすでに行っていることだけを説明するよりも説明的です。

于 2012-08-26T17:19:26.157 に答える
0

外部の依存関係がある場合、それについて言及するのは良いことだと思います。それが別の関数（PHPのmt_randvs.を参照）と対照的である場合はrand、言及するのも良いことです。

それ以外の場合は不要ですが、言及するかどうかは個人の好み次第です。

于 2012-08-26T17:19:44.180 に答える