首頁 php教程 php手册 PHP註解語法規範與命名規範

PHP註解語法規範與命名規範

May 16, 2016 am 09:00 AM
php註釋

註解在寫程式碼的過程中非常重要,好的註解能讓你的程式碼讀起來更輕鬆,在寫程式碼的時候一定要注意註解的規範,這裡腳本之家小編就為大家整理一下,需要的朋友可以參考下。

hp註解規範

註解在寫程式碼的過程中非常重要,好的註解能讓你的程式碼讀起來更輕鬆,寫程式的時候一定要注意註解的規範。

「php是一門及其容易入門的語言,剛入門的新手不到幾分鐘的時間可能就會用echo打印出一個hello world !但是他是真正的程式設計師嗎?怎麼來定義程式設計師呢?如果想真正成為一個程式設計師,那麼就必須遵循一套程式書寫規範,」

我們經常寫一些函數,但是這些函數可能也只有自己能看得懂,甚至過一段時間自己也不認識自己寫的了,那該怎麼辦呢?最好的方法當然是給自己的程式碼加上註解。

我們可能熟悉很多註解的寫法c pear php註解等等,但我們用到的主要還是# 和/**/。

#是一種簡短的註解方法。可能你會用它去註解一個變量,或是呼叫的一個方法。 /**/我們可能還在用它去註解掉一大段程式碼,但是怎麼用它去標準的註解一個函數呢?

/**
* @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 定义版本信息
*/
登入後複製

註解的資訊很全面,可能有很多我們用不到,紅色部分是我們常用的。

範例:php裡面常見的幾種註釋方式:

1.文件的註釋,介紹檔名,功能以及作者版本號等資訊

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

文件頭模板

/** 
*这是一个什么文件 
* 
*此文件程序用来做什么的(详细说明,可选。)。 
* @author   richard<e421083458@163.com> 
* @version   $id$ 
* @since    1.0 
*/
登入後複製

2.類別的註釋,類別名稱及介紹

/**
* 类的介绍
* 
* 类的详细介绍(可选)
* @author 作者
* @version 版本号
* @date 2020-02-02
*/
登入後複製
/** 
* 类的介绍 
* 
* 类的详细介绍(可选。)。 
* @author     richard<e421083458@163.com> 
* @since     1.0 
*/ 
class test  
{ 
}
登入後複製

3.函數的註釋,函數的作用,參數介紹以及返回類型

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

函數頭註解

/** 
* 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();}
登入後複製

程式碼註解

1. 註解的原則是將問題解釋清楚,並不是越多越好。

2. 若幹語句作為一個邏輯程式碼區塊,這個區塊的註解可以使用/* */方式。

3. 具體到某一個語句的註釋,可以使用行尾註解://。

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

php命名規範

1 .目錄和檔案

目錄使用小寫下劃線
類別庫,函數檔案統一以.php為後綴
類別的檔案名稱皆以命名空間定義,並且命名空間的路徑和類別庫檔案所在路徑一致
類別檔案採用駝峰法命名(首字母大寫),其他檔案採用小寫下劃線命名
類別名稱和類別檔案名稱保持一致,統一採用駝峰法(首字母大寫)

2.函數與類,屬性命名

類別的命名採用駝峰法(首字母大寫),例如user、usertype,預設不需要添加後綴,例如usercontroller應該直接命名為user
函數的命名使用小寫字母和下劃線(小寫字母開頭)的方式,例如get_client_ip
方法的命名使用駝峰法(首字母小寫),例如getusername(如果方法有返回值,那麼目前習慣上將首字母用小寫的屬性類型,如s(string),i (int),f(float),b(boolean),a(array)等)
屬性的命名使用駝峰法(首字母小寫),例如tablename、instance(目前習慣上將首字母用小寫的屬性類型,如s(string),i(int),f(float),b(boolean),a(array)等)
以雙底線「__」打頭的函數或方法作為魔法方法,例如__call 和__autoload

3.常數和配置

常數以大寫字母和底線命名,例如app_path和think_path
配置參數以小寫字母和底線命名,例如url_route_on 和url_convert

4.資料錶盒字段

資料表和字段採用小寫加下劃線方式命名,並注意字段名不要以下劃線開頭,例如think_user 表和user_name字段,不建議使用駝峰和中文作為資料表欄位命名。

本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn

熱AI工具

Undresser.AI Undress

Undresser.AI Undress

人工智慧驅動的應用程序,用於創建逼真的裸體照片

AI Clothes Remover

AI Clothes Remover

用於從照片中去除衣服的線上人工智慧工具。

Undress AI Tool

Undress AI Tool

免費脫衣圖片

Clothoff.io

Clothoff.io

AI脫衣器

AI Hentai Generator

AI Hentai Generator

免費產生 AI 無盡。

熱門文章

R.E.P.O.能量晶體解釋及其做什麼(黃色晶體)
2 週前 By 尊渡假赌尊渡假赌尊渡假赌
倉庫:如何復興隊友
4 週前 By 尊渡假赌尊渡假赌尊渡假赌
Hello Kitty Island冒險:如何獲得巨型種子
4 週前 By 尊渡假赌尊渡假赌尊渡假赌

熱工具

記事本++7.3.1

記事本++7.3.1

好用且免費的程式碼編輯器

SublimeText3漢化版

SublimeText3漢化版

中文版,非常好用

禪工作室 13.0.1

禪工作室 13.0.1

強大的PHP整合開發環境

Dreamweaver CS6

Dreamweaver CS6

視覺化網頁開發工具

SublimeText3 Mac版

SublimeText3 Mac版

神級程式碼編輯軟體(SublimeText3)

PHP註解大揭密:單行註解與多行註解詳細對比 PHP註解大揭密:單行註解與多行註解詳細對比 Mar 15, 2024 pm 12:51 PM

PHP註解大揭密:單行註解和多行註解詳細對比PHP是一種廣泛應用的網頁開發語言,其中註解的使用對於程式碼的可讀性和維護性起著至關重要的作用。在PHP中,常見的註釋有單行註釋和多行註釋兩種形式。本文將詳細比較這兩種註釋形式,並提供具體的程式碼範例,幫助讀者更好地理解它們的用法和差異。一、單行註解單行註解是在程式碼中加入一行註釋,以//開頭,直到行尾為止。單行註解

php註解的種類有哪些 php註解的種類有哪些 Aug 23, 2023 pm 01:46 PM

php註解的種類有單行註解、多行註解、文件註解和條件註解等。詳細介紹:1、單行註釋以雙斜杠“//”開頭,用於註釋單行代碼,在這種註釋類型中,從雙斜杠開始到該行末尾的所有內容都將被視為註釋,不會被解釋為程式碼;2、多行註解以斜線星號「/」開頭,以星號斜線「*/」結尾,這種註解類型可用於註解一段程式碼或多行程式碼;3、文件註釋也以斜杠星號“/”開頭,以星號斜杠“*/”結尾等等。

PHP中的程式碼註釋 PHP中的程式碼註釋 May 23, 2023 am 08:27 AM

程式碼註釋是程式設計師在編寫程式碼時添加的文字提醒,以便自己和其他程式設計師更輕鬆地閱讀和理解程式碼。在PHP中,程式碼註解是不可或缺的。本文將詳細介紹PHP中的程式碼註解的類型、規格和用途。一、PHP中的程式碼註解類型在PHP中,有三種類型的註解:單行註解、多行註解和文件註解。單行註解單行註解以雙斜線「//」開始,直到行尾結束。例如://這是一個單行註解多行註解多行註解以“

php的註解種類有哪些 php的註解種類有哪些 Jul 25, 2023 pm 02:26 PM

php的註解種類有:1、單行註釋,用於解釋某個功能、提醒其他開發者或自己注意點等;2、多行註釋,用於對多行程式碼區塊進行詳細的說明;3、文件註釋,用於對整個程式碼區塊或函數、方法進行詳細的說明。

深入了解PHP註解:單行註解和多行註解的區別 深入了解PHP註解:單行註解和多行註解的區別 Mar 15, 2024 pm 05:15 PM

進入PHP程式設計領域,註解是一個非常重要的概念。在編寫程式碼時,註解對於闡述程式碼意圖、幫助其他開發者理解程式碼邏輯以及方便自己日後維護程式碼都是至關重要的。在PHP中,註解分為單行註解和多行註解兩種,在使用上有一些差異。本文將深入探討PHP註解的特點以及單行註解和多行註解的使用方式,並透過具體的程式碼範例進行說明。 1.單行註解單行註解是在程式碼中加入一行註釋,用來解釋

PHP註解規格:如何使用文檔註解撰寫API文檔 PHP註解規格:如何使用文檔註解撰寫API文檔 Jul 30, 2023 pm 07:00 PM

PHP註解規格:如何使用文件註解撰寫API文件引言:在開發PHP應用程式時,撰寫完善的API文件對於開發團隊和其他開發者來說非常重要。好的文件可以提高程式碼的可讀性和可維護性,並促進團隊合作與資訊共享。本文將介紹如何使用文件註解撰寫PHP的API文檔,並提供一些範例程式碼幫助讀者理解如何規範地撰寫註解。註釋規範在PHP中,我們使用註釋來對程式碼進行說明和描述。一般

如何在PHP中使用註解來增強程式碼可讀性和理解性 如何在PHP中使用註解來增強程式碼可讀性和理解性 Jul 15, 2023 pm 09:27 PM

如何在PHP中使用註解來增強程式碼可讀性和理解性引言:在開發過程中,註解是一個非常重要的組成部分,可以幫助開發者更好地理解程式碼,提高程式碼的可讀性和維護性。本文將介紹在PHP中如何使用註解來增強程式碼的可讀性和理解性,並提供一些實際的程式碼範例。單行註解單行註解是用來對程式碼的某一行進行解釋和說明。在PHP中,單行註解以雙斜線(//)開頭,直到行尾結束。下面是一個範例

PHP註解類型詳解:單行註解與多行註釋 PHP註解類型詳解:單行註解與多行註釋 Mar 15, 2024 pm 05:27 PM

PHP是一種流行的伺服器端腳本語言,廣泛應用於Web開發領域。在程式碼編寫過程中,註解是一個非常重要的元素,可以幫助開發者更好地理解程式碼,提高程式碼的可讀性和可維護性。本文將詳細介紹PHP中的註釋類型,包括單行註釋與多行註釋,同時提供具體的程式碼範例。單行註解在PHP中,使用雙斜線//可以實現單行註解。單行註解從//開始一直到該行的末尾。單行註解通常用於對程式碼進行

See all articles