PHP&学习第一个问题:编程规范 - MrLee博客 - 一个伪全桟工程师的小站

MrLee博客

落子无悔,人生无返

PHP&学习第一个问题:编程规范

在刚开始学习PHP的时候要注意代码的对齐和缩进

一、刚开始学习的初学者应该了解两种:

1.代码“=” 缩进和对齐
比如:

<?php

$str  = 1;
$info = '12';
$i    = '1.20'

2.变量和常量的规范 使用英文来命名(不会可以百度翻译)
比如:

<?php
# 正确的做法
$title = "标题";
$name  = "名称";

#错误的
$biaoti = "标题";
$ming   = "名称";

二、在了解完function() 函数封装后,得注意function()函数头的说明
比如:

<?php
/**
 * 函数体简单的描述
 * @author_start   作者
 * @author_end     修改时间 + 修改者
 * @param 数据类型  变量1  传参的描述
 * @param 数据类型  变量2  传参的描述
 * @param 数据类型  变量3  传参的描述
 * @return 数据类型 返回值说明
*/
function Test(变量1, 变量2, 变量3, ...){
}

常见的注释:
1.多行注释,当对某代码进行大量的注释
比如:

/*
* 说明
* 流程1
* 流程2
* ……
*/

2.对一行代码做小量描述时
比如:

# 这是AAA变量给CCC的变量,叫name
$name = "";

3、当需要对一行代码,做简介描述时,使用以下注释风格

$name       = ''; // X表的字段
$index_head = ''; // 首页请求头

三、由于一个项目需要由许多个PHP文件组成,所以每一个文件的说明都相关重要,它关系着后期代码维护的便捷性与可读性。

<?php
/*
 +----------------------------------------------------------------------
 + Title        : 标题
 + Author       : 作者
 + Version      : 版本号
 + Initial-Time : 这个文件初始创建的时间
 + Last-time    : 这个文件最后修改的时间 + 修改人的名称
 + Desc         : 这个文件的简单描述
 +----------------------------------------------------------------------
*/

以上是关于注释和说明,下面说一下关于缩进省略和命名规范

一、为什么需要这样实现,同时,这样编程代码的好处都有什么?

    <?php
    # 一般在if语句与其分支的流程控制语句当中,存在这exit或者return的情况下,都应该省略其else的部分操作

   # 使用else
    if () {
        echo "这是使用else";
    } else {
        echo "我是else";    
    }
    # 使用exit 就应该省略else部分
    if () {
        echo "这是使用exit";
        exit;
    }
    echo "我省略了else";

// 使用return 也是同理
    if () {
        return false;
    }
    return true;

二、命名规范

<?php
/**
 * 实际开发中,命名方式一般有三种情况
 * 注意:不管是类名,变量,函数名,在实际开发中,最多只能是不超过3个单词的组合
 * 大驼峰 :每个单词首字母大写
 * 小驼峰 :中间单词首字母大写
 * 蛇形   :每个单词都是小写,单词和单词直接使用“_”符号链接
 */
 
# 大驼峰,常用于类名定义
class NewFun{}
class New{}
 
# 小驼峰,常用于函数名定义
function newFun(){}
 
# 蛇形,常用于变量名定义
$name_id = '1';
$new_blue= 'red';

本次问题的总结结束,本人慢慢在学习写博客,在下一次的问题中,还是会总结问题的所在,并且记录学习。

本文共642字

评论卡