집 > 기사 > 백엔드 개발 > PHP 주석 구문 사양 및 명명 규칙을 사용하는 단계에 대한 자세한 설명

PHP 주석 구문 사양 및 명명 규칙을 사용하는 단계에 대한 자세한 설명

php中世界最好的语言원래의: 2018-05-19 14:28:501472검색

이번에는 PHP 주석문법 사양 및 명명 규칙을 사용하는 단계에 대해 자세히 설명합니다. PHP 주석 문법 사양 및 명명 규칙을 사용할 때 노트란 무엇인가요?

HP 주석 사양

코드를 작성하는 과정에서 주석은 매우 중요합니다. 좋은 주석을 사용하면 코드를 더 쉽게 읽을 수 있습니다.

"PHP는 시작하기 매우 쉬운 언어입니다. 이제 막 시작한 초보자도 에코를 사용하여 몇 분 안에 hello world를 인쇄할 수 있습니다! 하지만 그가 진짜 프로그래머인가요? 진정한 프로그래머가 되려면 일련의 프로그램 작성 표준을 따라야 합니다.”

우리는 종종 일부 함수를 작성하지만 이러한 함수는 우리 자신만이 이해할 수 있고 작성하는 방법조차 모를 수도 있습니다. 그래, 우리는 어떻게 해야 하지? 가장 좋은 방법은 물론 코드에 주석을 추가하는 것입니다.

우리는 주석 작성, C pear PHP 주석 등 다양한 방법에 익숙할 수 있지만, 우리가 사용하는 주요 방법은 # 및 /**/.

#은 짧은 댓글 방식입니다. 어쩌면 변수에 주석을 달거나 메소드를 호출하는 데 사용할 수도 있습니다. /**/입니다. 코드는 있지만 어떻게 사용하나요? 함수의 표준 주석은 어떻습니까?

/**
* @name name
* @abstract는 변수/클래스/메서드를 선언합니다.
* @access는 이 변수, 클래스, 함수/메서드에 대한 액세스 권한을 지정합니다.
* @author 함수 작성자의 이름과 이메일 주소

* @ 카테고리는 패키지를 구성합니다
* @copyright는 저작권 정보를 지정합니다
* @const는 상수를 지정합니다
* @deprecate는 더 이상 사용되지 않거나 더 이상 사용되지 않는 정보를 지정합니다
* @example 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(문자열), i(int), f(float), b(부울), a(배열) 등)
tableName, 인스턴스(현재 s(문자열), i(int), f(float), b(boolean), a(배열) 등과 같이 첫 글자가 있는 소문자 속성 유형을 사용하는 것이 일반적입니다.)
함수 또는 메서드 이중 밑줄 ""로 시작하는 것은 call 및 autoload

3. 상수 및 구성

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

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

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

이 기사의 사례를 읽은 후 방법을 마스터했다고 생각합니다. 더 흥미로운 정보를 보려면 PHP 중국어 웹사이트의 다른 관련 기사를 주목하세요!