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

如果在类中使用了设计模式,则该类顶部或相关方法顶部的注释应解释所使用的特定设计模式或实际功能.

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

要么

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

这是极其简化的说明

我查询的主要内容是是否要依靠其他人想知道使用了什么设计模式,还是仅仅通过说出使用了什么设计模式就可能像聪明人一样碰到

解决方法:

常见的做法是为您的类命名(即XyzFactory),这样很容易看到您使用的模式并在注释中给出实际的功能,比起仅描述设计模式已经完成的工作,最好是更具描述性的.

上一篇:有什么理由或用例在php中使用self关键字而不是static关键字?


下一篇:如何在不违反OO核心原则的情况下使用Fragments?