如果在类中使用了设计模式,那么类顶部或相关方法顶部的注释是否应解释所使用的特定设计模式或实际功能。
即
/**
* Class MyClass
*
* Utilizes Factory Method patter to accomplish xyz
*/
或
/**
* Class MyClass
*
* Allows the creation of objects for xyz
*/
为了说明,这是极其简化的
我的主要问题是,是否要依赖其他人来了解使用了什么设计模式,或者仅仅说使用了什么样的设计模式,是否会给人一种聪明的感觉。
通常的做法是为类命名(即XyzFactory),这样很容易看到您使用的模式,并在注释中给出实际的功能性,最好是更具描述性,而不是只描述设计模式已经做了什么。
如果存在外部依赖性,那么我认为提及它是件好事。如果它与另一个函数形成对比(参见PHP的mt_rand
与rand
),那么它也是值得一提的。
否则,这是没有必要的,但是否提及它仍然取决于个人偏好。