집 > 기사 > 백엔드 개발 > PHP 프로그램의 표준 주석에 대한 사양 지침

PHP 프로그램의 표준 주석에 대한 사양 지침

不言원래의: 2018-07-19 15:13:567560검색

php는 비교적 시작하기 쉬운 언어로 많은 사람들이 쉽게 시작할 수 있지만, 배우는 과정에서는 PHP의 표준 주석 사양도 준수해야 합니다.

우리는 종종 어떤 함수를 작성하지만, 이러한 함수는 시간이 지나면 우리가 작성한 내용조차 인식하지 못할 수도 있습니다. 가장 좋은 방법은 물론 코드에 주석을 추가하는 것입니다.

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

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

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

* @category 조직 패키지
* @copyright 저작권 정보 지정
* @const 상수 지정
* @deprecate 더 이상 사용되지 않거나 쓸모 없는 정보 지정
* @example 예제
* @exclude 현재 주석이 분석되지 않고 document
* @final은 최종 클래스, 메소드, 속성임을 나타내며 파생 및 수정이 금지됩니다.
* @global은 이 함수에서 참조하는 전역 변수를 지정합니다
* @include는 포함된 파일의 정보를 지정합니다
* @link는 온라인 연결을 정의합니다
* @module은 소속 모듈 정보를 정의합니다
* @modulegroup은 소속 모듈 그룹을 정의합니다
* @package는 소속된 패키지의 정보를 정의
* @param은 함수나 메소드의 매개변수 정보를 정의
* @return은 함수나 메소드의 반환 정보를 정의
* @see는 참조해야 할 함수와 변수를 정의 을 클릭하고 해당 하이퍼링크를 추가합니다.
* @since는 API 함수 또는 메서드가 도입된 버전을 나타냅니다.
* @static은 변수, 클래스 및 함수가 정적임을 나타냅니다.
* @throws는 이 함수가 발생할 수 있는 오류 예외와 발생 상황을 나타냅니다.
* @todo는 개선되어야 하거나 구현되지 않아야 하는 영역을 나타냅니다.
* @var는 변수/속성을 정의합니다.
* @version은 버전 정보를 정의합니다
*/

주석이 달린 정보는 매우 포괄적이므로 우리가 사용하지 않는 정보가 많을 수 있으며 빨간색 부분은 우리가 자주 사용하는 정보입니다.

예:

파일 헤더 템플릿

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

함수 헤더 댓글

/** 
* 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();}

클래스 댓글

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

프로그램 코드 댓글

1. 댓글의 원리는 문제를 설명하는 것입니다. 분명히 , 더 많은 것이 좋지 않습니다.

2. 여러 문장이 논리 코드 블록으로 사용되며, 이 블록의 주석은 /* */일 수 있습니다.

3. 특정 명령문과 관련된 주석의 경우 줄 끝 주석을 사용할 수 있습니다: //.

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

PHP 프로그램의 표준 주석에 대한 사양 지침

관련 기사