Home php教程 php手册 PHP 代码规范小结_php基础

PHP 代码规范小结_php基础

May 17, 2016 am 09:00 AM
Code specifications

命名规范
Θ 类文件都以.class.php为后缀,使用驼峰法命名,并且首字母大写,例如 Pay.class.php;
Θ 类名和目录_文件名一致。例如:类名Zend_Autoloader的目录是Zend/Autoloader.class.php;
Θ 函数的命名使用小写字母和下划线的方式。例如:get_client_ip;
Θ 方法的命名使用驼峰法,首字母小写或者使用下划线"_",例如listComment(),_getResource(),通常下划线开头的方法属于私有方法;
Θ 属性的命名使用驼峰法,首字母小写或者使用下划线"_",如$username,$_instance,通常下划线开头的属性属于私有属性;
Θ 常量以大写字母和下划线"_"命名,如"HOME_URL";
常用名词
1>list名词(单数),如listApple,一看我们就知道读取苹果列表,我们没有必要写成getApples或者listApples或readApples——因为get我们规定一般用于读取单个数据,如getApple.listApples不加s我们也知道是取苹果列表(保证尽量缩短变量命名);
2>get名词(单数);
3>名词Total,表示某个东西的总数。如expenseTotal;
4>found:表示某个值是否已经找到;
5>uccess或ok:一项操作是否成功;
6>done:某个工程是否完成;
7>error:是否有错误发生;
8>result:返回的结果
代码重构
1.函数或者方法体内的代码尽量控制在一个屏幕内。
2.类中不使用的方法随机删除。
3.修改别人的类中方法,要签名。
4.在每个模块内写个readme文件(用于比较复杂业务的说明或代码说明)。
5.尽量让每个类做自己的事,每个函数做一件事。
常用代码
用&&或||简化操作
简化前:
复制代码 代码如下:

$a=1;
$b = 0;
if(isset($a)){
$b=1;
print($b."\n");
}
if($b!=0){
print($b."\n");
}

简化后:
复制代码 代码如下:

$a=1;
$b = 0;
isset($a) && ($b=1) && print($b."\n");
$b == 0 || print($b."\n");


明显代码看起来更加整齐,更加简单!
判断"=="时,把常量放在前面
之前:
复制代码 代码如下:

$a = 1;
if($a = 1){
echo '$a == 1';
}

之后:
复制代码 代码如下:

$a = 1;
if(1 = $a){
echo '$a == 1';
}

明显,常量放在前面的话,编译器就能判断错误。
正规格式:
复制代码 代码如下:

$a = 1;
if(1 == $a){
echo '$a == 1';
}

查找表法
之前:
复制代码 代码如下:

/*错误码:4,5,7,8的时候返回状态1,错误码是1,3,6返回状态2*/
$error = 4;
$state = 0;
if($error == 4 || $error == 5 || $error == 7 || $error == 8){
$state = 1;
}
if($error == 1 || $error == 3 || $error == 6){
$state = 2;
}
echo "$state \n";

之后:
复制代码 代码如下:

/*错误码:4,5,7,8的时候返回状态1,错误码是1,3,6返回状态2*/
$error = 4;
$state = 0;
$arr = array(4 => 1, 5 => 1, 7 => 1, 8 => 1, 1 => 2, 3 => 2, 6 => 2);
isset($arr[$error]) && ($state = $arr[$error]);
echo "$state \n";

明显代码更加凝练,更加清楚,更易懂,速度也更快!
总结
本来想把什么设计模式也往常用代码里放置,但是太多了,不太好放。这些只是微部而已!
大家如果有更好的写法的话,可以留言。
Statement of this Website
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn

Hot AI Tools

Undresser.AI Undress

Undresser.AI Undress

AI-powered app for creating realistic nude photos

AI Clothes Remover

AI Clothes Remover

Online AI tool for removing clothes from photos.

Undress AI Tool

Undress AI Tool

Undress images for free

Clothoff.io

Clothoff.io

AI clothes remover

AI Hentai Generator

AI Hentai Generator

Generate AI Hentai for free.

Hot Article

R.E.P.O. Energy Crystals Explained and What They Do (Yellow Crystal)
2 weeks ago By 尊渡假赌尊渡假赌尊渡假赌
R.E.P.O. Best Graphic Settings
2 weeks ago By 尊渡假赌尊渡假赌尊渡假赌
R.E.P.O. How to Fix Audio if You Can't Hear Anyone
2 weeks ago By 尊渡假赌尊渡假赌尊渡假赌

Hot Tools

Notepad++7.3.1

Notepad++7.3.1

Easy-to-use and free code editor

SublimeText3 Chinese version

SublimeText3 Chinese version

Chinese version, very easy to use

Zend Studio 13.0.1

Zend Studio 13.0.1

Powerful PHP integrated development environment

Dreamweaver CS6

Dreamweaver CS6

Visual web development tools

SublimeText3 Mac version

SublimeText3 Mac version

God-level code editing software (SublimeText3)

How to check code convention and quality using PHP and PHPUnit How to check code convention and quality using PHP and PHPUnit Jun 25, 2023 pm 04:57 PM

In modern software development, code quality and specifications are extremely important factors. Not only can it make the code cleaner and easier to maintain, it can also improve the readability and scalability of the code. But how do you check the quality and specification of your code? This article will explain how to use PHP and PHPUnit to achieve this goal. Step 1: Check the code specification. In PHP development, there is a very popular code specification, which is called PSR (PHP Standard Specification). The purpose of the PSR specification is to make PHP code more readable and maintainable. in

How to write and maintain code documentation in Java development How to write and maintain code documentation in Java development Oct 10, 2023 pm 08:22 PM

How to write and maintain code documentation in Java development In the Java development process, writing and maintaining code documentation is a very important part. A good code document can improve the readability and maintainability of the code, facilitate collaboration and communication between project members, and also help with later code maintenance and iteration. Use of comments Comments are the basis of code documentation. They can be used to explain the function of the code, implementation logic, parameter description, etc. In Java, there are three types of comments: single-line comments (//) and multi-line comments (/.

How to standardize performance optimization through PHP code specifications How to standardize performance optimization through PHP code specifications Aug 11, 2023 pm 03:51 PM

How to standardize performance optimization through PHP code specifications Introduction: With the rapid development of the Internet, more and more websites and applications are developed based on the PHP language. In the PHP development process, performance optimization is a crucial aspect. A high-performance PHP code can significantly improve the website's response speed and user experience. This article will explore how to standardize performance optimization through PHP code specifications and provide some practical code examples for reference. 1. Reduce database queries. Frequent database queries are a common feature during the development process.

In-depth understanding of React's custom Hooks In-depth understanding of React's custom Hooks Apr 20, 2023 pm 06:22 PM

React custom Hooks are a way to encapsulate component logic in reusable functions. They provide a way to reuse state logic without writing classes. This article will introduce in detail how to customize encapsulation hooks.

How to set up code specification reminders in the development environment to keep up to date with the latest PHP code specifications? How to set up code specification reminders in the development environment to keep up to date with the latest PHP code specifications? Sep 05, 2023 am 09:18 AM

How to set up code convention reminder in development environment to keep up to date with PHP code convention? Abstract: During the development process, following code specifications can improve the readability and maintainability of the code. This article will introduce how to use code specification checking tools and IDEs to set code specification reminders to help developers keep the latest PHP code specifications. 1. Code specification checking tool Code specification checking tool can detect and remind code that does not comply with the specification during the code writing process. The following are several commonly used PHP code specification checking tools. PHP

How to solve the indentation irregularity error in Python code? How to solve the indentation irregularity error in Python code? Jun 24, 2023 pm 04:39 PM

As a high-level programming language, Python has particularly strict requirements for indentation in its code, because Python code blocks are defined through indentation. Therefore, code with irregular indentation will easily cause syntax errors and confusion in program logic, affecting the readability and execution efficiency of the code. So, how to solve the indentation irregularity error in Python code? Here are a few common ways to resolve indentation irregularities in Python code: Use the auto-indent feature of your text editor Many text editors, such as S

Code style specifications for golang functions Code style specifications for golang functions Apr 28, 2024 pm 05:48 PM

The Go function code style specification follows best practices to ensure code readability and maintainability, including: function names begin with a lowercase letter and words are separated by underscores. Parameter types precede parameter names, separated by commas. The return type is declared before the function body. Code snippets are short and readable, separated by blank lines. Write clear comments explaining the intent of your code. Variable names start with a lowercase letter and are named in camel case. Constant names are in all capital letters, with underscores separating words. Interface names start with the "I" prefix.

How to automatically check whether PHP code complies with the latest code specifications? How to automatically check whether PHP code complies with the latest code specifications? Sep 06, 2023 pm 12:33 PM

How to use tools to automatically check whether PHP code complies with the latest coding standards? Introduction: In the software development process, we often need to follow certain code specifications to ensure the readability, maintainability and scalability of the code. However, manually checking code specifications is a tedious and error-prone task. In order to improve efficiency and reduce errors, we can use some tools to automatically check code specifications. In this article, I will introduce how to use some popular tools to automatically check whether PHP code complies with the latest coding standards. 1. PH

See all articles