General principles:
1, the Semantics of
When you see a name, you know what it means.
2. Universal Prefix
Is indicates whether, get represents read, and set represents write. is followed by the adjective, not the noun, such as whether multilingual, should use is_multilingual, rather than is_multilanguage.
3. Singular and plural
Refer to the function naming rules of JS: getElementById, getElementsByTagName, Getelementsbyname.
For example:
Take the names of my multiple friends and use Getfriendsname instead of getfriendnames or getfriendname
Take a user, is GetUser
Take multiple users, is getusers
4. Redundant suffix
Try not to use the data, list, and info suffixes.
For example, the naming of JS is very careful, use getElementsByTagName instead of getelementsinfobytagname.
You should use Getfriends or getfriendsuserid instead of getfriendslist; you should use GetUser instead of GetUserInfo or getuserdata.
However, sometimes it is difficult to avoid, for example, there are 2 functions, which are the basic information of the user, and the user details are taken.
Basic information of User: Nickname, Avatar Uri, function name Getuserbasic or Getuserbasicinfo? The function name is not appropriate for the end of the adjective, to be discussed.
Take user details: Nickname, Avatar Uri, signature, birthday, function name GetUser no problem.
5, ambiguous meaning of the class name, file name, directory name
Whenever using common, util, functions, Class, Object, basic as the file name to be cautious, because these words are too general, the development of things may be more and more, into the garbage box. To give these an accurate name, for example, to do string processing class, can be called stringlib.php, placed in the Lib directory.
6. The difference between Lib, plugin and addon
Some classes, functions are counted as LIB, plugin or addon. Pending discussion.
Class Name:
Capital letters start with the hump named. Nouns are commonly used, such as configuring parsing classes Configparser, rather than parseconfig.
Consistent with Java, C + +.
Example: Class Usermodel
The file name of the class:
Same as the class name. This is related to PHP autoload, in order to AutoLoad, the class name is always very long, pending discussion.
Consistent with Java.
For example, the file name of Class Usermodel is usermodel.php
Non-class file name:
All lowercase, underline-delimited, and no spaces are allowed. Like get_user.php.
Directory Name:
All lowercase, underline-delimited, and no spaces are allowed. such as model, www.
Name of function:
Lowercase letters start with the hump named, for example: function Addblog ().
Consistent with Java, C + +.
functions represent functions, i.e. actions, so verbs are preferred, such as using Editblog instead of Blogedit.
PHP built-in functions for historical reasons, there are many styles, do_something,something_do,dosomething, compared to the new function with the dosomething, only with the current mainstream language consistent.
For example: Paser_str, Json_encode, substr, Fetchall.
Historical reasons may not change, but we can guarantee that the new code is rigorous, and don't let yourself be a historical cause.
Functions in the class:
Two empty rows in the middle of the function. If there is time, the functions are sorted alphabetically, lest it be too confusing.
For example:
Class Blogmodel
{
Public Function Addblog ()
{
}
Public Function Updateblog ()
{
}
}
File Comments:
Comments follow Format according to Phpdoc requirements: http://manual.phpdoc.org/HTMLframesConverter/default/phpDocumentor/tutorial_tags.author.pkg.html
/**
* Blog of various business: Add, update
* @author Sink
*
*/
Class Blogmodel
{
}
?>
API notes:
Be sure to write the input parameters, and the output format. Write clearly what is output when it is correct, and what is output when the error occurs.
Otherwise no one else can use it.
Function Comment:
Be sure to write the output format. Write clearly what is output when it is correct, and what is output when the error occurs.
If the input parameters are complex, include the array, see the parameters can not be seen at a glance, then write the input parameter comments.
There cannot be a blank line between a document comment and a function.
If the steps inside the function are complex, you need to write an in-line comment.
For example:
/**
* Update Blog
* @param int $id blog_id
* @param array $data Array (
"Content" = "" ",//Contents
"Tags" = "" ",//tags
"Update_time" = "" ",//Update time
)
* @return BOOL
*/
Public Function Updateblog ($id, $data)
{
Step1//First step: asdf
Step2//Second step: Qwer
}
Uri:
According to the provisions of RFC1034 International standard, the domain name is forbidden to appear the underscore "_", the domain name is not case-sensitive.
For example, http://dl_dir.qq.com/is the wrong domain name.
Http://bkjia.com is the same as Http://VERYHUO.COM.
So precedence is used in the URI with all lowercase, get's name lowercase, except for the get value.
Like what
Http://www.google.com/?hl=zh-CN
Http://www.google.com/?hl=zh-cn
The abbreviation for the proper noun of the non-parameter of the URI is used in lowercase and is disputed.
Like what
http://fedoraproject.org/zh_CN/
http://zh.wikipedia.org/zh-cn/
http://code.google.com/intl/zh-CN/
http://www.microsoft.com/en-us/
The language literal code is a proper noun, the ISO must be a minus sign, and the recommended area is capitalized.
The usage of Fedora is strange, using the zh_cn that you make, not ZH-CN. It is also not recommended to use underscores in URIs.
The wiki was lowercase, Google capitalized, and Microsoft used lowercase.
Use the minus sign "-" instead of the underscore in the URI, except for the name of get.
Like what
Http://example.com/1-2-2
Http://example.com/?user_id=123
If you want the user to enter the URI manually, do not distinguish between case and lowercase, because user input is more convenient.
The reality is that users typically enter the domain name manually without entering the URI manually because the URI is very long. In this case, if the URI lowercase is meaningful, if you use http://example.com/?userId=123, the variable name can use the hump $userid = $_get[' userId '), it will be consistent with Java, C + +, So the database will also have to name the hump. Pending discussion.
Variable:
All lowercase, underline delimited, for example: $user _id.
Inconsistent with Java, C + +. Pending discussion.
The member variables of the class, the formal parameters of the function, and the class are instantiated into an object, respecting the naming conventions of the variables.
Reason: URI, database has lowercase convention, get parameters from $_get, $_post, so use lowercase.
PHP built-in variables $_get, $_post use underscores to start with, all caps. No matter how important a custom variable is, don't start with an underscore to avoid future conflicts with built-in variables.
For example: Do not use $_put, $_delete.
Constant:
All uppercase, underline delimited. For example: const MEMCACHE_TTL = 600;
PHP Short Tags:
Use , do not use short labels 。 Because it conflicts with XML and is not conducive to deployment.
Class curly Braces Wrap:
You can take a single line of curly braces, or you can put curly braces on one line with the other, and there is no conclusive argument, pending discussion.
Class Usermodel
{
}
Support changer:
http://www.php.net/manual/zh/language.oop5.basic.php
http://pear.php.net/manual/en/standards.classdef.php
Please click on the next page for more information!
- Total 2 Pages:
- Previous page
- 1
- 2
- Next page
http://www.bkjia.com/PHPjc/363931.html www.bkjia.com true http://www.bkjia.com/PHPjc/363931.html techarticle general principles: 1, semantic to see the name, you know the meaning. 2. The universal prefix is indicates whether, get is read, and set represents write. is followed by adjectives rather than nouns, such as ...
