DoitPHP Coding Specifications

Scope of application Unless otherwise specified, the following rule requirements are fully applicable to DoitPHP projects (Note: Doitphp's PHP framework file, not PHP projects developed using DoitPHP). If you like the following coding standards, you can also use them in other PHP development projects.​

The Importance and Benefits of Standardization "No rules, no squares." When the development of a software project adheres to public and consistent standards, the entire team members form and maintain a consistent coding style, and the entire project document is written by one person. Each programmer's code is easy to understand for others, improving the maintainability of the code and thus reducing the maintenance cost of the software. At the same time, new participants can quickly adapt to the environment, thereby maximizing the efficiency of team development cooperation. Long-term standardized coding can also allow developers to develop good coding habits, reduce the chance of coding errors, and even develop more rigorous thinking. The purpose of "documenting" the specifications is to clarify our coding standards. We believe that standards are not the key to project success, but they can help us be more efficient in team collaboration and complete set tasks more smoothly.

PHP coding specifications and principles 1. File format 1.1. File encoding: File encoding is unified to UTF-8 (Note: non-UTF-8 BOM). 1.2. PHP code tags: Use "<?php ?>" at any time to define your PHP code. And "<? ?>" will be prohibited. For code files that only contain PHP, it is recommended to ignore the "?>" at the end of the file to prevent extra spaces or other characters from affecting the code. 1.3. Indentation rules: Use 4 spaces for indentation instead of TAB. This is already the standard in the PHP industry, and we will not "go against the trend of history." The main reason for using spaces is to make the code look neat and tidy. Because in different editors, the length of the TAB tab character is different, but the space is the same. Using TAB can solve the problem by pressing the TAB key, but using spaces requires pressing the space bar four times, which obviously affects development efficiency. At present, many editors default to a TAB occupying four spaces (how many spaces it occupies can be adjusted by the editor). If this is the case, in order to improve development efficiency, you can use TAB with confidence. This indentation specification also applies to functions, classes, logical structures, loops, etc. in JavaScript. 1.4. Code content: No extra spaces or TAB characters are allowed at the end of each line (make sure your editor saves the file in Unix format, which means lines are terminated with newlines). Except for the language pack annotation configuration file, there cannot be Chinese anywhere else. 1.5. Code comments: Files must have clear code comments, and the comment style adopts the phpDocumentor standard