php-代码注释-应该注释使用的设计模式
内容导读
互联网集市收集整理的这篇技术教程文章主要介绍了php-代码注释-应该注释使用的设计模式,小编现在分享给大家,供广大互联网技能从业者学习和参考。文章包含519字,纯文字阅读大概需要1分钟。
内容图文
如果在类中使用了设计模式,则该类顶部或相关方法顶部的注释应解释所使用的特定设计模式或实际功能.
即
/**
* Class MyClass
*
* Utilizes Factory Method patter to accomplish xyz
*/
要么
/**
* Class MyClass
*
* Allows the creation of objects for xyz
*/
这是极其简化的说明
我查询的主要内容是是否要依靠其他人想知道使用了什么设计模式,还是仅仅通过说出使用了什么设计模式就可能像聪明人一样碰到
解决方法:
常见的做法是为您的类命名(即XyzFactory),这样很容易看到您使用的模式并在注释中给出实际的功能,比起仅描述设计模式已经完成的工作,最好是更具描述性的.
内容总结
以上是互联网集市为您收集整理的php-代码注释-应该注释使用的设计模式全部内容,希望文章能够帮你解决php-代码注释-应该注释使用的设计模式所遇到的程序开发问题。 如果觉得互联网集市技术教程内容还不错,欢迎将互联网集市网站推荐给程序员好友。
内容备注
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 gblab@vip.qq.com 举报,一经查实,本站将立刻删除。
内容手机端
扫描二维码推送至手机访问。