PHP博客系统开发day1 代码规范与项目目录组织

内容：

1、代码规范

2、组织项目目录和文件

1、代码规范

代码规范的意义:

便于排查[缩进规范]
减少沟通成本,便于团队合作[命名规范]
便于文档自动化生成[注释规范] 有很多第三方的工具，可以自动化的生成文档,通过读取我们的注释
有利于求职[代码很规范]

常见规范注释：

 1 // 文件说明
 2 /** 
 3 *第一行两个*号 
 4 *其余行也以*号开头 
 5 *@author @link @since @copyright等 
 6 */
 7 
 8 // 页面级别的注释
 9 /** 
10 *index.php blog首页 
11 * 
12 *@author wyb <[email protected]>   //作者邮箱 
13 *@link http://www.xxx.xxx         //作者的关系链接 
14 *@since 2019年5月18日                //版本号或是日期 
15 *@copyright GPL                    //版权,开源软件 GPL协议 */

下面这个网站提供的软件可以将注释转成文档,自然我们写注释需要以他给出的标准作为规范 http://www.phpdoc.org/

具体注释有几种, 参考下面的链接, 并不要求一一都写: http://www.phpdoc.org/docs/latest/index.html

函数说明：

还有命名规范也很重要：

还有其他的一些注意点:

对于类文件,文件名一般和类名相同(方便查找和使用)
关于缩进,一般是用4个空格来缩进,有时候一些编辑器会配置一个tab可以缩进4个空格, 但不是代表缩进用一个tab,没有配置就不可以使用

以上为一些注意点和常用规范, 作为一个成熟的程序员以上这些为大家所熟知的常识

2、组织项目目录和文件

项目的文件/目录清晰有条理,有助于提高开发效率并减少错误我们按如下格式组织项目在web服务器根目录下新建blog文件夹,并在其下新建如下目录：

1 /css        #放置css文件 
2 /images     #图片
3 /log        #系统日志 
4 /view       #模板目录 
5     /front  #前台模板 
6     /admin  #后台模板 
7 /upload     #上传文件 
8 /lib        #底层库文件 
9 index.php   #用户直接访问的php文件

index.php代码如下：

 1 <?php 
 2     
 3 /*
 4 * index.php 首页
 5 *
 6 * @author: wyb
 7 * @time: 2019/05/18 
 8 * @copyright: GPL
 9 */
10 
11 header("Content-type:text/html;charset=utf-8");
12     
13 
14 require './view/front/index.html';
15 
16 
17 ?>

PHP博客系统开发day1 代码规范与项目目录组织

猜你喜欢