浅谈文档编写和编码规范－【书评】《PHP高级程序设计》

开发大型项目或者参与团队开发的人，对文档和编码规范不会陌生，这几乎会占据项目开发的很大部分时间，由此可见文档在项目中的重要程度不言而喻，那么怎么样才能编写出让人通俗易懂的文档呢？让我谈谈自己的看法！

首先，在团队开发中，每个人都会有自己的代码风格，如何能让整个项目显得统一整齐，就需要靠一套编码规范来约束，使整个项目代码的风格开起来就像是一个人编写似的！
其次，项目完成之后，如何能让人快速上手，这时候就需要一整套完整的文档来辅助你了，可以说好的文档可以让一个项目更上一层楼！

而具体到PHP中，文档编写和编码规范又有其特有的方法。
在样章中，作者首先阐述了在Zend和Pear中的一些常见的编码规范，虽然这些规范并不是强制性的、必须的，但是遵守这些规范会给你的工作上带来许多便利。在代码风格统一后，就是注释和文档了。本章用了大量篇幅来介绍注释和文档之间的关系，要想生成好的文档，注释的写法是非常的关键，利用PHPDoc自带的一套注释规范就能够便捷快速的生成文档。如果你想生成更复杂的文档，就需要用到DocBook了，它利用XML特性可以设计更加综合性的文档来。可以说看过这一章之后，你会对PHP的编码规范和文档如何编写有了一个明确的认识。

好的文档不仅可以让人更快的理解项目，也可以让人们之间的沟通更加流畅，所以大家以后在编写代码的时候要时刻谨记啊！

PHPDoc主页
http://www.phpdoc.org/

DocBook主页
http://www.docbook.org/

围观lz发的网址

其实LZ说的这些，许多人都懂，但是真要实践起来，时间充足的项目还好，时间不够的。嘿嘿