Spécification du style de programmation PHP principes de base de Sharing

Remarque : cette spécification est compilée par EasyChen sur la base de la "Spécification de développement C++" du département de développement d'applications réseau SINA, de la "Spécification de développement PHP4" du département de technologie interactive et de la spécification phpDocument. Je pense que c'est très bien et adapté au développement PHP. C'est une référence pour tout le monde. Il est très nécessaire de développer un bon style de programmation.

Chapitre 1 Conventions de dénomination

1.1 Variables

1.1.1 Variables globales

Les variables globales commencent par $g_, comme $g_data_list.

1.1.2 Variables générales

Généralement, les variables sont nommées avec des lettres minuscules et les mots sont séparés par des traits de soulignement.

Les noms de variables doivent utiliser des noms ou des adjectifs + des noms. Tel que $value, $new_value.

1.1.3 Variables temporaires

N'utilisez pas de variables temporaires telles que $i, $j, etc. qui sont fréquemment utilisées dans les boucles à d'autres fins.

1.2 Fonction

Les fonctions sont nommées avec des lettres minuscules et les mots sont séparés par des traits de soulignement.

Il est recommandé d'utiliser verbe + nom pour nommer des fonctions, telles que get_user_img.

Mettez une fonction qui complète un ensemble de fonctions dans un fichier, et le fichier stockant la fonction est nommé function_name.func.php.

Classe 1.3

La classe

utilise la majuscule anglaise pour séparer les mots, y compris le premier mot, et la première lettre de tous les mots est en majuscule, comme PageManager

;

Dans une classe, placez les méthodes avant les définitions d'attributs et les méthodes publiques avant les méthodes spéciales

Généralement, une classe correspond à un fichier

Lorsque certaines classes sont étroitement liées, elles peuvent être stockées dans un seul fichier

Le fichier stockant la classe est nommé ClassName.class.php.

Méthode 1.4

La méthode

utilise la majuscule anglaise pour séparer les mots À l'exception du premier mot, la première lettre des autres mots est en majuscule, comme getCurrentPage();

N'utilisez pas d'abréviations inhabituelles, telles quewhere2go();

Lorsque vous utilisez des abréviations couramment utilisées, mettez uniquement la première lettre en majuscule, comme getHtml().

Chapitre 2 Règles de format

2.1 Séparation sémantique

Des lignes vierges doivent être utilisées entre chaque fonction et méthode ;

Les sauts de ligne ne sont pas requis entre des instructions étroitement liées dans la même fonction. Les sauts de ligne sont requis dans d'autres cas.

2.2 Règles d'espace

2.2.1 Des espaces doivent être ajoutés avant et après les opérateurs logiques

Correct

Copier le code Le code est le suivant :$a == $b; >

Erreur

Copier le code

Le code est le suivant :$a==$b;$a ==$b;

Correct

Copier le code

Le code est le suivant :$a++; 🎜> Erreur

Copier le code

Le code est le suivant :$a ++; > Remarques : Les opérateurs d'addition et de soustraction ne peuvent pas ajouter d'espaces. 2.2.2 Des espaces doivent être ajoutés lors de la séparation de plusieurs paramètres

Correct

Copier le code

Le code est le suivant :

$g_pro , $g_user , g_show get_db_info ($host, $user, $passwd)

Erreur

Copier le code

Le code est le suivant :

$g_pro,$g_user,$g_show; get_db_info($host,$user,$passwd);

2.2.3 Un espace doit être ajouté après le mot-clé de syntaxe

Par exemple : Si, pendant, pendant, changez…..
Correct

Copier le code

Le code est le suivant :

pour ($i = 0 ; $i < 10 ; $i++ ) Erreur

Copier le code

Le code est le suivant :

pour($i = 0; $i < 10 ; $i++ ) 2.3 Règles de connexion des chaînes et des variables Lorsque les chaînes et les variables sont connectées à l'aide du signe '.', des espaces doivent être ajoutés avant et après le '.', et lorsque le signe "." " doit être ajouté avant et après la variable.Correct

Copier le code

Le code est le suivant :

$my_name = 'file_' $var1 . ; $mon_nom = "fichier_{$var1}"

오류

코드 복사 코드는 다음과 같습니다.

$my_name = "file_'.$var1 ; 
$my_name = "file_$var1" 

2.4 괄호 규칙
함수 이름 뒤에는 공백을 추가할 필요가 없으며, 구문 키워드 뒤에는 공백을 추가해야 합니다.
맞습니다

코드 복사 코드는 다음과 같습니다.

for ($i = 0; $i < 10 ; $i++ ) 
strlen($my_name) 

오류

코드 복사 코드는 다음과 같습니다.

for($i = 0; $i < 10 ; $i++ ) 
strlen ($my_name) 

2.5 중괄호 규칙
중괄호는 윗부분과 아랫부분이 일치해야 합니다.

맞습니다

코드 복사 코드는 다음과 같습니다.

if ($a) 
 { 
 $b = $a 
 } 

오류

코드 복사 코드는 다음과 같습니다.

if ($a){ 
 $b = $a 
 } 

2.6 배열 정의 규칙

배열을 정의하고 사용할 때는 키 값 앞뒤에 작은따옴표를 넣어야 합니다.
PHP 코드:
올바름

코드 복사 코드는 다음과 같습니다.

array( 'name' => ' ', '성별' => '' ) 
$user_info['이름'] 

오류

코드 복사 코드는 다음과 같습니다.

array( name => '', 성별 => ; '' ); 
$user_info[이름];

2.7 SQL 규칙

PHP에 포함된 모든 SQL 문 키워드는 대문자여야 합니다.
필드 이름의 공백으로 인해 발생하는 오류를 방지하려면 테이블 이름과 필드 이름을 백틱(`)으로 묶어야 합니다. . 오류가 발생했습니다.
데이터 값은 양쪽에 작은따옴표 ''로 묶여 있으며, SQL 삽입을 방지하려면 데이터 값의 작은따옴표를 이스케이프 처리해야 합니다.

맞습니다

코드 복사 코드는 다음과 같습니다.

$sql = "SELECT `user`.`name` FROM `user` WHERE `id` = '$id' LIMIT 1";

오류

코드 복사 코드는 다음과 같습니다.

$sql = "id가 있는 이름에서 name.user를 선택하세요. = $id ";

제3장 댓글 규칙

3.1 일반 규칙
코드가 로직을 잘 설명하지 못하는 경우에만 불필요한 댓글을 작성하지 말고, 이를 보완하기 위해 댓글을 사용하세요.
댓글을 일부로 생각하세요. 프로그램의 주석은 코드 작성/유지와 동시에 작성/유지됩니다.
주석은 API 수준의 문서 생성을 용이하게 하기 위해 PHPDocumentor의 사양을 완전히 채택합니다.

3.2 세부 규칙
PHPDocumentor 매뉴얼을 참고하세요. 각 부분에 대한 주석 예시는 다음과 같습니다.

3.2.1 저작권 정보
주석 이름 저작권 정보
주석 예:

코드 복사 코드는 다음과 같습니다.

//
// +- --- ---------------------------------- -+
// | phpDocumentor |
// +--------------------------------- ------ ---------------+
// | Copyright (c) 2000-2003 Joshua Eichorn |
// | 이메일 보내기 |
// | 웹 http://www.phpdoc.org |
// +------------- ------ -------+
// | 이 소스 파일에는 PHP 라이센스가 적용됩니다 |
// +-- ------ ------------------ ------+
// 

PHP 코드:

코드 복사 코드는 다음과 같습니다.

/**
* 인라인 태그의 모든 추상 표현은 이 파일에 있습니다.
* @package phpDocumentor
* @subpackage InlineTags
* @since 버전 1.2 이후 별도 파일
* @version $Id $
*/

비고
1) 파일 헤더 주석은 해당 파일이 속한 패키지와 하위 패키지를 나타내야 합니다.
2) CVS를 사용하여 파일을 쉽게 관리하려면 @version에 $ID를 추가하세요.

3.2.3 클래스 주석 예
주석 이름 클래스 주석
주석 예:

PHP 코드:

코드 복사 코드는 다음과 같습니다.

/**
* 이 요소를 사용하여 {@}link}와 같은 {@}인라인 태그}를 나타냅니다.
* @see parserStringWithInlineTags
* @package phpDocumentor
* @subpackage InlineTags
* @author Greg Beaver 
* @since 1.0rc1
* @version $Revision: 1.21.2.6 $
* @tutorial inlinetags.pkg
*/

3.2.4 클래스 속성 주석 예
주석 이름 클래스 속성 주석
주석 데모:
PHP 코드:

코드 복사 코드는 다음과 같습니다.

/**
* 요소 유형
*
* 유형은 
*
* <br>* if get_class($blah) == '의 번거로움을 건너뛰기 위해 많은 함수에서 사용됩니다. parserBlah'<br>* 
* 항상 "inlinetag"
* @var string
*/
var $type = 'inlinetag';

3.2.5 함수/클래스 메소드 주석 예시
주석 이름 함수/클래스 메소드 주석
주석 예시:
PHP 코드:

코드 복사 코드는 다음과 같습니다.

/**
* @return 문자열은 항상 ''
* DocBlock의 간단한 설명을 계산합니다.
* @seeparserStringWithInlineTags::getString()
* @seeparserStringWithInlineTags::trimmedStrlen()
*/
함수 getString()
{
 return '';
}

Spécification du style de programmation PHP principes de base de Sharing_php