代码注释 - 应该评论使用的设计模式

Question

如果在类中使用了设计模式，那么类顶部或相关方法顶部的注释是否应解释所使用的特定设计模式或实际功能。

即

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

或

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

这非常简化以说明

我的询问的主要部分是，是否依赖于其他人想知道使用了什么样的设计模式，或者是否只是通过说出使用了什么样的设计模式而成为一个聪明的屁股

Answer 1

通常的做法是命名你的类（即XyzFactory），这样就可以很容易地看到你使用的模式，并在评论中给出实际的功能，最好是描述性而不仅仅是描述设计模式已经做到的。

Answer 2

如果有外部依赖性，那么我会认为它很好。如果它与另一个函数形成对比（参见PHP的mt_rand与rand），那么也值得一提。

否则，这是不必要的，但仍然取决于个人喜好是否提及。