Asas perkongsian_php spesifikasi gaya pengaturcaraan PHP

Nota: Spesifikasi ini disusun oleh EasyChen berdasarkan "Spesifikasi Pembangunan C++" Jabatan Pembangunan Aplikasi Rangkaian SINA, "Spesifikasi Pembangunan PHP4" Jabatan Teknologi Interaktif, dan spesifikasi phpDocument. Saya fikir ia sangat baik dan sesuai untuk pembangunan PHP Ia adalah rujukan untuk semua orang.

Konvensyen Penamaan Bab 1

1.1 Pembolehubah

1.1.1 Pembolehubah global

Pembolehubah global bermula dengan $g_, seperti $g_data_list.

1.1.2 Pembolehubah umum

Secara amnya, pembolehubah dinamakan dengan huruf kecil dan perkataan dipisahkan dengan garis bawah.

Nama pembolehubah hendaklah menggunakan kata nama atau kata adjektif + kata nama. Seperti $value, $new_value.

1.1.3 Pembolehubah sementara

Jangan gunakan pembolehubah sementara seperti $i, $j, dsb. yang kerap digunakan dalam gelung untuk tujuan lain.

1.2 Fungsi

Fungsi dinamakan dengan huruf kecil dan perkataan dipisahkan dengan garis bawah.

Adalah disyorkan untuk menggunakan kata kerja + kata nama apabila menamakan fungsi, seperti get_user_img.

Letakkan fungsi yang melengkapkan set fungsi ke dalam fail, dan fail yang menyimpan fungsi itu dinamakan function_name.func.php.

Kelas 1.3

Kelas

menggunakan huruf besar bahasa Inggeris untuk memisahkan perkataan, termasuk perkataan pertama, dan huruf pertama semua perkataan menggunakan huruf besar, seperti

;

Dalam kelas, letakkan kaedah sebelum definisi atribut dan kaedah awam sebelum kaedah khas;

Secara amnya, kelas sepadan dengan fail;

Apabila sesetengah kelas berkait rapat, mereka boleh disimpan dalam satu fail;

Fail yang menyimpan kelas dinamakan ClassName.class.php.

1.4 Kaedah

Kaedah

menggunakan huruf besar bahasa Inggeris untuk memisahkan perkataan Kecuali untuk perkataan pertama, huruf pertama perkataan lain adalah dengan huruf besar, seperti getCurrentPage();

Jangan gunakan singkatan yang tidak biasa, seperti where2go();

Apabila menggunakan singkatan yang biasa digunakan, hanya gunakan huruf besar huruf pertama, seperti getHtml().

Peraturan Format Bab 2

2.1 Pemisahan Semantik

Barisan kosong hendaklah digunakan antara setiap fungsi dan kaedah;

Pemisahan baris tidak diperlukan antara pernyataan yang berkait rapat dalam fungsi yang sama diperlukan dalam kes lain.

2.2 Peraturan ruang

2.2.1 Ruang mesti ditambah sebelum dan selepas operator logik

Betul

Salin kod

Kod adalah seperti berikut:$a == $b; > Ralat

Salin kod

Kod adalah seperti berikut:

$a==$b;$a ==$b;

Betul

Salin kod

Kod adalah seperti berikut:

$a--; 🎜> Ralat

Salin kod

Kod adalah seperti berikut:

$a ++; >

Catatan: Operator tambah dan tolak tidak boleh menambah ruang. 2.2.2 Ruang mesti ditambah apabila memisahkan berbilang parameterBetul

Salin kod

Kodnya adalah seperti berikut:

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

Ralat Salin kod

Kod adalah seperti berikut:

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

2.2.3 Ruang mesti ditambah selepas kata kunci sintaks Contohnya: Jika, untuk, sementara, tukar…..Betul

Salin kod

Kod adalah seperti berikut:

untuk ($i = 0; $i < 10 ; $i++ )

Ralat

Salin kod Kod adalah seperti berikut:

untuk($i = 0; $i < 10 ; $i++ )

2.3 Peraturan sambungan rentetan dan pembolehubah

Apabila rentetan dan pembolehubah disambungkan menggunakan tanda '.', ruang mesti ditambah sebelum dan selepas '.', dan apabila tanda "." " mesti ditambah sebelum dan selepas pembolehubah.

Betul

Salin kod

Kodnya adalah seperti berikut:

$my_name = 'file_' ;
$my_name = "file_{$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 라이센스가 적용됩니다 |
// +-- ------ ------------------ ------+
//

참고: PHPDocumentor의 페이지 수준 DocBlock과의 충돌을 피하기 위해 //를 사용하여 저작권 정보를 표시합니다.

3.2.2 파일 헤더 주석 예

댓글 이름 파일 헤더 주석
댓글 데모 :

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 '';
}

Kenyataan Laman Web ini

Kandungan artikel ini disumbangkan secara sukarela oleh netizen, dan hak cipta adalah milik pengarang asal. Laman web ini tidak memikul tanggungjawab undang-undang yang sepadan. Jika anda menemui sebarang kandungan yang disyaki plagiarisme atau pelanggaran, sila hubungi admin@php.cn