Spesifikasi sintaks komen PHP dan konvensyen penamaan

Komen sangat penting dalam proses menulis kod yang baik boleh memudahkan kod anda dibaca Semasa menulis kod, anda mesti memberi perhatian kepada spesifikasi komen Di sini, editor Script House akan menyelesaikannya anda. Rakan yang memerlukan boleh merujuknya.

Spesifikasi Komen HP

Komen sangat penting dalam proses menulis kod kod, pastikan anda memberi perhatian kepada spesifikasi ulasan.

“PHP ialah bahasa yang sangat mudah untuk dimulakan. Seorang pemula yang baru bermula mungkin boleh menggunakan gema untuk mencetak dunia helo dalam masa kurang daripada beberapa minit? Bagaimana untuk melakukannya? Bagaimana dengan mentakrifkan seorang pengaturcara? Jika anda ingin benar-benar menjadi seorang pengaturcara, anda mesti mengikut satu set piawaian penulisan program "

Kami sering menulis beberapa fungsi, tetapi fungsi ini hanya boleh difahami. oleh diri kita sendiri, malah Sudah agak lama saya tidak mengenali apa yang saya tulis, jadi apakah yang perlu saya lakukan? Cara terbaik sudah tentu dengan menambah komen pada kod anda.

Kami mungkin biasa dengan banyak cara menulis ulasan, ulasan C pear PHP, dll., tetapi yang utama yang kami gunakan ialah # dan /**/.

# ialah kaedah ulasan ringkas. Mungkin anda akan menggunakannya untuk menganotasi pembolehubah atau memanggil kaedah. /**/ keluar sebahagian besar kod , tetapi bagaimana untuk menggunakannya untuk menganotasi fungsi secara standard?

/**
* @name 名字
* @abstract 申明变量/类/方法
* @access 指明这个变量、类、函数/方法的存取权限
* @author 函数作者的名字和邮箱地址
* @category 组织packages
* @copyright 指明版权信息
* @const 指明常量
* @deprecate 指明不推荐或者是废弃的信息
* @example 示例
* @exclude 指明当前的注释将不进行分析，不出现在文挡中
* @final 指明这是一个最终的类、方法、属性，禁止派生、修改。
* @global 指明在此函数中引用的全局变量
* @include 指明包含的文件的信息
* @link 定义在线连接
* @module 定义归属的模块信息
* @modulegroup 定义归属的模块组
* @package 定义归属的包的信息
* @param 定义函数或者方法的参数信息
* @return 定义函数或者方法的返回信息
* @see 定义需要参考的函数、变量，并加入相应的超级连接。
* @since 指明该api函数或者方法是从哪个版本开始引入的
* @static 指明变量、类、函数是静态的。
* @throws 指明此函数可能抛出的错误异常,极其发生的情况
* @todo 指明应该改进或没有实现的地方
* @var 定义说明变量/属性。
* @version 定义版本信息
*/

Maklumat dalam anotasi adalah sangat komprehensif. Mungkin terdapat banyak bahagian yang tidak kami gunakan.

Contoh: Beberapa kaedah ulasan biasa dalam php:

1 Ulasan pada fail, memperkenalkan nama fail, fungsi, nombor versi pengarang dan maklumat lain

/**
* 文件名简单介绍
* 
* 文件功能
* @author 作者
* @version 版本号
* @date 2020-02-02
*/

Templat Pengepala Fail

/** 
*这是一个什么文件 
* 
*此文件程序用来做什么的（详细说明，可选。）。 
* @author   richard<e421083458@163.com> 
* @version   $Id$ 
* @since    1.0 
*/

2. Komen kelas, nama kelas dan pengenalan

/**
* 类的介绍
* 
* 类的详细介绍（可选）
* @author 作者
* @version 版本号
* @date 2020-02-02
*/

/** 
* 类的介绍 
* 
* 类的详细介绍（可选。）。 
* @author     richard<e421083458@163.com> 
* @since     1.0 
*/ 
class Test  
{ 
}

3 Ulasan fungsi, fungsi fungsi, pengenalan parameter dan jenis pulangan

/**
* 函数的含义说明
* 
* @access public 
* @author 作者
* @param mixed $arg1 参数一的说明 
* @param mixed $arg2 参数二的说明
* @return array 返回类型
* @date 2020-02-02
*/

Komen pengepala fungsi

/** 
* some_func 
* 函数的含义说明 
* 
* @access public 
* @param mixed $arg1 参数一的说明 
* @param mixed $arg2 参数二的说明 
* @param mixed $mixed 这是一个混合类型 
* @since 1.0 
* @return array 
*/ 
public function thisIsFunction($string, $integer, $mixed) {return array();}

Komen kod program

1 jelas bahawa lebih banyak tidak selalu lebih baik.

2. Beberapa pernyataan digunakan sebagai blok kod logik, dan komen blok ini boleh menjadi /* */.

3 Untuk ulasan khusus untuk pernyataan tertentu, anda boleh menggunakan ulasan akhir baris: //.

/* 生成配置文件、数据文件。*/ 
 
$this->setConfig(); 
$this->createConfigFile(); //创建配置文件 
$this->clearCache();     // 清除缓存文件 
$this->createDataFiles();  // 生成数据文件 
$this->prepareProxys(); 
$this->restart();

Konvensyen penamaan PHP

1. Direktori dan fail

Gunakan huruf kecil untuk direktori + Underscore
Perpustakaan kelas dan fail fungsi semuanya diakhiri dengan .php
Nama fail kelas semuanya ditakrifkan dalam ruang nama dan laluan ruang nama adalah konsisten dengan laluan fail perpustakaan kelas
Fail kelas dinamakan menggunakan huruf besar unta (Huruf pertama huruf besar), fail lain dinamakan dalam huruf kecil + garis bawah
Nama kelas dan nama fail kelas adalah konsisten, dan kaedah kes unta digunakan secara seragam (huruf pertama ditulis dengan huruf besar)

2. Fungsi dan kelas, penamaan atribut

Kelas dinamakan menggunakan huruf besar (huruf pertama huruf besar), seperti User, UserType Secara lalai, tiada akhiran adalah ​​diperlukan. Contohnya, UserController hendaklah dinamakan terus Pengguna
Fungsi dinamakan menggunakan huruf kecil dan garis bawah (bermula dengan huruf kecil) Contohnya, nama kaedah get_client_ip
menggunakan kes unta (huruf pertama ialah huruf kecil), seperti getUserName (jika kaedah mempunyai nilai pulangan, pada masa ini adalah kebiasaan untuk menggunakan huruf pertama dalam huruf kecil untuk jenis atribut, seperti s(string), i(int ), f (float), b ( boolean), a (array), dsb.)
Penamaan atribut menggunakan huruf besar unta (huruf pertama adalah huruf kecil), seperti tableName, contoh (adalah kebiasaan untuk menggunakan huruf kecil untuk huruf pertama jenis atribut, Seperti s (rentetan), i (int), f (float), b (boolean), a (array), dll.)
Fungsi atau kaedah bermula dengan garis bawah berganda "__" digunakan sebagai kaedah ajaib, seperti sebagai __call dan _ _autoload

3 Pemalar dan konfigurasi

Pemalar dinamakan dengan huruf besar dan garis bawah, seperti APP_PATH dan THINK_PATH
Parameter konfigurasi dinamakan dengan huruf kecil dan garis bawah, seperti sebagai url_route_on dan url_convert

4 medan kotak jadual data

Jadual dan medan data dinamakan dalam huruf kecil dan bergaris bawah, dan berhati-hati untuk tidak memulakan nama medan dengan garis bawah, seperti jadual think_user dan medan nama_pengguna tidak disyorkan untuk menggunakan kotak unta dan bahasa Cina untuk penamaan medan.