한국어
한국어
PHP 기능에 대한 명확하고 포괄적 인 문서를 작성하는 것은 모듈 식, 유지 관리 가능 및 팀 기반 코드에 필수적입니다. 표준화 된 문서화 관행은 문서가 일관되고 이해하기 쉬운 것을 보장 할 수 있습니다.
함수 이름은 소문자로 시작하고 밑줄이있는 별도의 단어 (예 : my_function)로 시작해야합니다. 동시에, PSR-2 명명 규칙에 따라 클래스 및 메소드 이름은 Camel Nomenclature (예 : MyFunction)를 사용해야합니다.
@Param 태그를 사용하여 함수 매개 변수의 유형 및 설명을 지정하십시오.
/**
* @Param String $ 이름 사용자 이름* @Param String $ 암호 비밀번호*/
함수 로그인 (문자열 $ 이름, 문자열 $ 암호) {}
@return 태그를 사용하여 반환 값 유형과 함수 설명을 지정하십시오.
/**
* @return bool 로그인이 성공했습니다*/
함수 로그인 (문자열 $ 이름, 문자열 $ 암호) : bool {}
@Throws 태그를 사용하여 함수가 던질 수있는 예외의 유형 및 설명을 지정하십시오.
/**
* @throws invalidargumentException $ name 또는 $ password가 비어있는 경우*/
함수 로그인 (문자열 $ 이름, 문자열 $ 암호) : bool {}
PSR-5 주석 블록 표준을 준수하는 기능 주석의 예 :
/**
* 로그인 사용자* @param 문자열 $ name username* @param string $ password password* @return bool 로그인이 성공 여부* @throws invalidargumentexception $ name 또는 $ password가 비어있는 경우*/
함수 로그인 (문자열 $ 이름, 문자열 $ 암호) : bool {}
예 : 현재 시간을 얻으십시오.
/**
* 현재 시간 가져 오십시오* @return String 현재 시간 문자열*/
함수 get_current_time () : 문자열 {
반환 날짜 ( 'ymd h : i : s');
}
예 : 두 숫자의 합을 계산하십시오.
/**
* 두 숫자의 합을 계산 * @param int $ 첫 숫자 * @param int $ b Second Number * @return int 및 */
함수 합계 (int $ a, int $ b) : int {
$ a + $ b를 반환합니다.
}
