PHP网页设计10 个项目文档最好理论

现在，也有了从事软件工程的想法，在经过了一个月的PHP培训学习之后，发现其实软件工程并没有想像中的那么难。    在软件开辟和保护过程当中，文档是必不成少的材料，它可以进步软件开辟的效力，包管软件的质量，并且在软件的利用过程当中有指点、匡助、解惑的感化。特别在保护任务中，文档的主要性更是不问可知。

本文收拾整顿了软件开辟中10个最好的文档编写理论，但愿能对你的任务有所匡助。

1.  将编写文档作为开辟任务中的一个主要环节（例如，占用总开辟工夫的10%）。在软件开辟中，不克不及没有文档，但假如编写文档占用了大局部的工夫也不适合。可以依据需求制订代码文档、需求申明文档、设计文档、测试文档、用户手册等，在制订完成后，可以经由过程版本掌握东西或基于Web的平台来办理和同享这些文档。

2.  代码文档十分主要的。最好的体例是编写“自申明”的代码，变量、办法、类、包等称号必需是成心义的，代码流必需是明晰的。关于十分庞杂的代码段，可以包括冗长的正文行。还可以在代码中添加相干的标签或正文，主动生成Javadoc文档。

3.  关于未来接办的开辟者，可觉得他们筹办一些冗长、适用的设计文档，个中需求包括关头设计特征和UML图等，无需呈现大批不用要的信息。

4.  需求/成绩/未交付项目/功效点跟踪文档也相当主要。利用跟踪东西将会使这项任务加倍无效率，这些东西可以匡助你完成一些像疾速搜刮、编纂等方面任务，并可以生成纯文本文档。

5.  测试跟踪文档也很主要。可使用一些东西来纪录测试场景和测试了局，并附上一些相干的需求。如许，可以很轻易地监督软件的功效形态。

6.  文档是一个延续性的任务，开辟人员应当随时更新或从头生成这些文档的最新版本，直到开辟历程停止。假如一个文档不是最新的，那末它毫无价值。

7.  关于文本模式的文档，版原形当主要。每个新的文档，必需有一个新的版本号（版本号由公司的版本办理战略来定），还需求将这些信息纪录在版本跟踪表中，以便更好地跟踪。

8.  有一个一致的文档模板。文档的页眉、页脚、题目、字体巨细必需分歧，如许可以加强可读性。还可以做得更好，好比加上封面、目次、图表、辞汇表等。

9.  还需求注重文档格局、利用的言语、错别字等。输出毛病、纷歧致的表格巨细、缩进等成绩，能够会分离浏览者的注重力。

10.  将项目中学到的经历纪录上去，并分享给其别人。开辟者在每一个项目中都能够会失掉一些适用的经历（好比架构、代码、设置装备摆设等），而这些经历信息不会呈现在尺度的开辟文档中。开辟者要不休堆集并分享这些经历，这能够会加速以后的开辟进度，并且关于未来做一些有应战的任务或反复性的任务，会有很大的匡助。

英文原文：10 Software Documentation Best Practices
讲了这么多，无非是想说：学习PHP不仅要掌握方法，更多的是付出汗水，我不希望看到中途放弃的人，相信自己，相信自己的选择，更要相信自己的能力，如果自己想放弃，暴力一点的话，就自己抽自己一个嘴巴。