PHP Coding Specifications Comments and File Structure Description_PHP Tutorial

File structure

|――images
|――include
　|――parameter
　|――config
　|――function
|――index
Images stores image files. Include is the file that the system wants to reference. Generally, parameter files are stored in parameter, configuration files are stored in config, and method files, such as javascript methods, are stored in function. Each function module is classified according to its classification. Functional classes are also placed in it
File name
Folder naming is generally in English, the length is generally no more than 20 characters, and the naming is in lowercase letters. Except for special circumstances, Chinese pinyin is used. Some common folder names are: images (storage graphics files), flash (storage Flash files), style (storage CSS files), scripts (storage Javascript scripts), inc (storage include files) , link (store friendly links), media (store multimedia files), etc. File names should be a combination of lowercase English letters, numbers and underscores.
Block Comments
Block comments are typically used to provide descriptions of files, methods, data structures, and algorithms. Block comments are placed at the beginning of every file and before every method. They can also be used elsewhere, such as inside methods. Block comments inside functions and methods should have the same indentation as the code they describe.
There should be a blank line at the beginning of the block comment to separate the block comment from the code, for example:
/*
　* Here is the block comment
*/
Block comments can Start with /*- so that indent(1) can recognize it as the beginning of a code block without rearranging it.
/*-
* If you want to be ignored, use specially formatted block comments
*
* one
*  two
*  three
*/
Note : If you don't use indent(1), you don't have to use /*- in your code, or give in to others who might run indent(1) on your code.
Single-line comments
Short comments can appear on one line and have the same indentation level as the following code. If a comment cannot be written in one line, use a block comment. Single-line comments should be preceded by a blank line. The following is an example of a single line comment in the code:
if (condition) {
　/* Conditions for the following code to run */
　...
}
Tail comment
Extreme Short comments can be on the same line as the code they describe, but there should be enough white space to separate the code and comments. If multiple short comments appear in a large block of code, they should have the same indentation.
The following is an example of a tail comment in the code:

Copy the code The code is as follows:

if ($a = = 2) {
return TRUE; /* Description of a single condition*/
} else {
return isPrime($a); /* Remaining conditions*/
}

Comment at the end of the line
The comment delimiter "//" can comment out the entire line or part of a line. It is generally not used to comment out multiple lines of text; however, it can be used to comment out multiple lines of code. Here are examples of all three styles:

Copy code The code is as follows:

if ($foo > 1) {
　//The second usage.
　...
}
else {
　return false; // Explain the reason for the return value
}
//if ($ bar > 1) {
//
// // The third usage
//　 ...
//}
//else {
　// return false ;
//}

Documentation comments
Documentation comments describe PHP classes, constructors, methods, and fields. Each documentation comment will be placed within the comment delimiter /**...*/, and one comment corresponds to a class or member. This comment should be placed before the declaration:

/**
　* Explain something about this class
* Describe some aspects of this class...

*/
class Example {

Note the top level (top-level) classes are not indented, but their members are indented. The first line (/**) of a documentation comment describing a class does not need to be indented; subsequent lines of documentation comments are indented by 1 space (so that the asterisks are aligned vertically). The first line of documentation comments for members, including constructors, is indented 4 spaces, and each subsequent line is indented 5 spaces. If you want to give information about a class, variable or method that is not suitable to be written in the documentation, you can use an implementation block comment (see 5.1.1) or a single-line comment immediately following the declaration ( See 5.1.2). For example, details about the implementation of a class should be placed in the implementation block comment immediately following the class declaration rather than in a documentation comment.

Documentation comments cannot be placed in the definition block of a method or constructor, because the program will associate the first declaration after the documentation comment with it.

http://www.bkjia.com/PHPjc/322068.htmlwww.bkjia.comtruehttp: //www.bkjia.com/PHPjc/322068.htmlTechArticle

File structure |――images |――include |――parameter |――config |――function |― ―index images stores image files. Include is the file that the system wants to reference, usually in