项目开发工具与.pdfVIP

工具规范

开发工具:SublimeText3

开发平台:appServerv2.5.10

流程导图软件：MindManager

流程图设计软件：DiagramDesigner

原型图软件：AxureRPPro7.0

数据库管理工具：NavicatforMySQL和phpmyadmin

编码部分

字符编码约定

统一的字符编码，使用UTF-8

代码注释规范

注释规范

注释是对于那些容易忘记作用的代码添加简短的介绍性内容，可以在PHP中使用

以“/**”开始和以“*/”作为结束的多行文档注释、还有普通多行注释“/**/”，以及单行

注释符号“//”。所有文档块建议和phpDocumentor格式兼容。PHPDocumentor是一个用PHP

写的工具，对于有规范注释的php程序，它能够快速生成具有相互参照,索引等功能的API

文档。可以通过在客户端浏览器上操作生成文档，文档可以转换为PDF,HTML,CHM几种形

式，非常的方便。PHPDocument是从你的源代码的注释中生成文档，因此在给你的程序做

注释的过程，也就是你编制文档的过程。从这一点上讲，PHPDocumentor促使你要养成良

好的编程习惯，尽量使用规范，清晰文字为你的程序做注释，同时多少也避免了事后编制文

档和文档的更新不同步的一些问题。在PHPDocumentor中，注释分为文注释和非文档

性注释。所谓文注释，是那些放在特定关键字前面的多行注释，特定关键字是指能够被

PHPDocumentor分析的关键字，例如class，var等。那些没有在关键字前面或者不规范的

注释就称作非文注释，这些注释将不会被PHPDocumentor所分析，也不会出现在你产

生的api文档中。

工具规范

开发工具：SublimeText3开发平台：

appServerv2.5.10软件：MindManagerChart

Designer原型图软件：AxureRPPro7.0

编码部分

字符编码规定

统一字符编码，使用UTF‑8

代码注释规范

注释规范

注解是为那些容易忘记的代码添加简短的介绍性内容，可以在PHP中使用以

“/**”开头、“*/”作为以“/**/”结尾的多行文档注释，也可以使用单行注释符号“//”。

所有文档块都与phpDocumentor格式兼容。通过操作客户端的浏览器即可生成文档，

可以将文档转换为PDF、HTML、CHM等多种格式，非常方便。PHPDocument是在你

的源代码中创建注释文档的过程，所以它是在你的程序中进行注释的过程，也就是你的文

档的过程。从这一点来说，PHPDocumentor鼓励您养成良好的编程习惯，在您的程序中

尽可能使用的、清晰的文本，避免一些文档更新不同步的问题。同时，

PHPDocumentor中，注释分为文档注释和非文档注释。注解是那些放在特定关键字前面

的、PHPDocumentor不分析的注解，例如class、var等。

文件顶部的注释

所有的文档注释都是由/**开始的一个多行注释，在phpDocumentor里称为DocBlock,

DocBlock是指软件开发人员编写的关于某个关键字的帮助信息，使得其他人能够通过它知

道这个关键字的具体用途，如何使用。PhpDocumentor规定一个DocBlock包含：功能简述

区；详细说明区；标记tag，每个包含PHP代码的文件必须至少在文件顶部的DocBlock包

含这些phpDocumentor。另外每一个程序文件头部中，应放入相应CVS控制字串，以

方便CVS提交时自动更新：

$RCSfile$