php - 代码注释 - 是否应该对使用的设计模式进行注释

Question

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

IE

/**
 *  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_randvs. rand），那么值得一提。

否则，没有必要，但是否提及仍取决于个人喜好。