PHP 주석 구문 사양 및 명명 규칙-php手册-php.cn

PHP 주석 구문 사양 및 명명 규칙

WBOY

풀어 주다： 2018-09-27 14:34:08

원래의

3018명이 탐색했습니다.

코드 작성 과정에서 댓글은 매우 중요합니다. 좋은 댓글은 코드를 읽기 쉽게 만들어줍니다. 코드를 작성할 때 댓글 사양에 주의해야 합니다. . 도움이 필요한 친구들이 참고할 수 있습니다.

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 명명 규칙

디렉터리 및 파일

소문자를 사용하세요. 디렉토리 + 밑줄
클래스 라이브러리, 함수 파일에는 .php라는 균일한 접미사가 붙습니다.
클래스 파일 이름은 네임스페이스에 정의되며, 네임스페이스 경로는 클래스 라이브러리 파일 경로와 일치합니다.
클래스 파일 Camel Case를 사용하여 명명(첫 글자는 대문자), 그 외 파일명은 소문자+밑줄로 명명
클래스명과 클래스 파일명이 일치하며, Camel Case 방식을 동일하게 사용한다(첫 글자는 대문자)

2. 함수 및 클래스, 속성 명명

클래스 이름은 User, UserType과 같이 Camel Case(첫 글자는 대문자)를 사용하여 지정됩니다. 기본적으로 접미사가 필요하지 않습니다. 예를 들어 UserController는 User
라는 이름을 직접 지정해야 합니다. 함수는 소문자와 밑줄(소문자로 시작)을 사용하여 이름을 지정합니다. 예를 들어, get_client_ip
메서드의 이름은 카멜 케이스를 사용합니다(첫 번째 문자는 소문자입니다). getUserName(메서드에 반환 값이 있는 경우 현재 s(string), i(int ), f(float), b(boolean)과 같은 속성 유형에 대해 첫 번째 문자를 소문자로 사용하는 것이 일반적입니다. a(배열) 등)
속성 이름 지정에는 tableName, 인스턴스(s 등 속성 유형의 첫 글자는 소문자를 사용하는 것이 현재 관례)와 같이 카멜 케이스(첫 번째 문자는 소문자)를 사용합니다. (string), i(int), f(float), b(boolean), a(array) 등)
이중 밑줄 "__"로 시작하는 함수나 메서드는 __call, _ _autoload

3. 상수 및 구성

상수는 APP_PATH 및 THINK_PATH와 같이 대문자와 밑줄로 이름이 지정됩니다.
구성 매개변수는 url_route_on 및 THINK_PATH와 같이 소문자와 밑줄로 이름이 지정됩니다. url_convert

4. 데이터 테이블 상자 필드

데이터 테이블과 필드는 소문자로 이름이 지정되고 밑줄이 그어져 있으며 think_user 테이블 및 user_name 필드와 같이 필드 이름이 밑줄로 시작되지 않도록 주의하세요. . 데이터 테이블 이름에는 카멜 표기법과 중국어를 사용하지 않는 것이 좋습니다.