PHP网页设计10 个项目文档最好理论
现在，也有了从事软件工程的想法，在经过了一个月的PHP培训学习之后，发现其实软件工程并没有想像中的那么难。 在软件开辟和保护过程当中，文档是必不成少的材料，它可以进步软件开辟的效力，包管软件的质量，并且在软件的利用过程当中有指点、匡助、解惑的感化。特别在保护任务中，文档的主要性更是不问可知。本文收拾整顿了软件开辟中10个最好的文档编写理论，但愿能对你的任务有所匡助。
1.将编写文档作为开辟任务中的一个主要环节（例如，占用总开辟工夫的10%）。在软件开辟中，不克不及没有文档，但假如编写文档占用了大局部的工夫也不适合。可以依据需求制订代码文档、需求申明文档、设计文档、测试文档、用户手册等，在制订完成后，可以经由过程版本掌握东西或基于Web的平台来办理和同享这些文档。
2.代码文档十分主要的。最好的体例是编写“自申明”的代码，变量、办法、类、包等称号必需是成心义的，代码流必需是明晰的。关于十分庞杂的代码段，可以包括冗长的正文行。还可以在代码中添加相干的标签或正文，主动生成Javadoc文档。
3.关于未来接办的开辟者，可觉得他们筹办一些冗长、适用的设计文档，个中需求包括关头设计特征和UML图等，无需呈现大批不用要的信息。
4.需求/成绩/未交付项目/功效点跟踪文档也相当主要。利用跟踪东西将会使这项任务加倍无效率，这些东西可以匡助你完成一些像疾速搜刮、编纂等方面任务，并可以生成纯文本文档。
5.测试跟踪文档也很主要。可使用一些东西来纪录测试场景和测试了局，并附上一些相干的需求。如许，可以很轻易地监督软件的功效形态。
6.文档是一个延续性的任务，开辟人员应当随时更新或从头生成这些文档的最新版本，直到开辟历程停止。假如一个文档不是最新的，那末它毫无价值。
7.关于文本模式的文档，版原形当主要。每个新的文档，必需有一个新的版本号（版本号由公司的版本办理战略来定），还需求将这些信息纪录在版本跟踪表中，以便更好地跟踪。
8.有一个一致的文档模板。文档的页眉、页脚、题目、字体巨细必需分歧，如许可以加强可读性。还可以做得更好，好比加上封面、目次、图表、辞汇表等。
9.还需求注重文档格局、利用的言语、错别字等。输出毛病、纷歧致的表格巨细、缩进等成绩，能够会分离浏览者的注重力。
10.将项目中学到的经历纪录上去，并分享给其别人。开辟者在每一个项目中都能够会失掉一些适用的经历（好比架构、代码、设置装备摆设等），而这些经历信息不会呈现在尺度的开辟文档中。开辟者要不休堆集并分享这些经历，这能够会加速以后的开辟进度，并且关于未来做一些有应战的任务或反复性的任务，会有很大的匡助。
英文原文：10 Software Documentation Best Practices
讲了这么多，无非是想说：学习PHP不仅要掌握方法，更多的是付出汗水，我不希望看到中途放弃的人，相信自己，相信自己的选择，更要相信自己的能力，如果自己想放弃，暴力一点的话，就自己抽自己一个嘴巴。 基础有没有对学习php没有太大区别，关键是兴趣。 首先声明：我是一个菜鸟，是一个初学者。学习了一段php后总是感觉自己没有提高，无奈。经过反思我认为我学习过程中存在很多问题，我改变了学习方法后自我感觉有了明显的进步。 首先我是坚决反对新手上来就用框架的，因为对底层的东西一点都不了解，造成知识上的真空，会对以后的发展不利。我的观点上手了解下框架就好，代码还是手写。当然啦如果是位别的编程语言的高手的话，这个就另当别论啦。 本人接触php时间不长，算是phper中的小菜鸟一只吧。由于刚开始学的时候没有名师指，碰过不少疙瘩，呗很多小问题卡过很久，白白浪费不少宝贵的时间，在次分享一些子的学习的心得。 对于初学者来说不推荐去拿钱买的。当然如果一个网站你经常去用，而且里面的资料也比较有用，最好还是买个会员比较好，毕竟那些也是别人的工作成果。 写的比较杂，因为我也是个新手，不当至于大家多多指正。 找到的的资料很多都是在论坛里的，需要注册，所以我一般没到一个论坛都注册一个id，所有的id都注册成一样的，这样下次再进来的时候就不用重复注册啦。当然有些论坛的某些资料是需要的付费的。 装在C盘下面可以利用windows的ghost功能可以还原回来（顺便当做是重转啦），当然啦我的编译目录要放在别的盘下，不然自己的劳动成果就悲剧啦。 兴趣是最好的老师，百度是最好的词典。 至于模板嘛，各位高人一直以来就是争论不休，我一只小菜鸟就不加入战团啦，咱们新手还是多学点东西的好。 基础有没有对学习php没有太大区别，关键是兴趣。 本文当是我的笔记啦，遇到的问题随时填充 为了以后维护的方便最好是代码上都加上注释，“予人方便，自己方便”。此外开发文档什么的最好都弄齐全。我觉得这是程序员必备的素质。虽然会消耗点很多的时间。但是确实是非常有必要的。 这些都是最基本最常用功能，我们这些菜鸟在系统学习后，可以先对这些功能深入研究。 如果你可以写完像留言板这样的程序，那么你可以去一些别人的代码了， 在我安装pear包的时候老是提示，缺少某某文件，才发现 那群extension 的排列是应该有一点的顺序，而我安装的版本的排序不是正常的排序。没办法我只好把那群冒号加了上去，只留下我需要使用的扩展。 对于懒惰的朋友，我推荐php的集成环境xampp或者是wamp。这两个软件安装方便，使用简单。但是我还是强烈建议自己动手搭建开发环境。 首先声明：我是一个菜鸟，是一个初学者。学习了一段php后总是感觉自己没有提高，无奈。经过反思我认为我学习过程中存在很多问题，我改变了学习方法后自我感觉有了明显的进步。 对于初学者来说不推荐去拿钱买的。当然如果一个网站你经常去用，而且里面的资料也比较有用，最好还是买个会员比较好，毕竟那些也是别人的工作成果。
页:
[1]