PHP 기능 문서 사양에 대한 개요
PHP 기능 문서 작성 사양에는 필요한 필드에 기능 이름, 매개 변수 (기본 매개 변수 포함), 반환 값 및 예외가 포함되어야합니다. 선택 필드에는 설명, 별명, 호환성, 감가 상각 및 버전 제거가 포함됩니다. 쓰기 규칙은 명확하고 간결한 언어를 강조하고 DocBlock 주석 형식을 사용하며 사례 예제를 통해 기능 사용 및 유형 프롬프트를 보여줍니다.
필요한 필드
- 함수 이름 : Camelcase를 사용하는 기능의 고유 식별자.
- 매개 변수 : $ param1, $ param2 등으로 명명 된 함수에 의해 허용되는 매개 변수 목록.
- 기본 매개 변수 : 함수의 매개 변수에 기본값 값이있는 경우 매개 변수 이름 뒤에 = DEFAULT_VALUE로 지정하십시오.
- 반환 값 : 함수에 의해 반환 된 값 유형.
- 예외 : 함수가 던질 수있는 예외 목록.
- 예 : 하나 이상의 데모 기능이 사용하는 코드의 예.
선택 필드
- 설명 : 기능 기능 및 용도에 대한 간단한 설명.
- 별칭 : 함수에 대한 모든 별칭.
- 호환성 : 기능이 지원하는 PHP 버전.
- 더 이상 사용되지 않는 PHP 버전의 기능.
- 제거 : PHP에서 제거 된 함수의 버전.
쓰기 규칙
- 구식 용어를 피하기 위해 명확하고 간결한 언어를 사용하십시오.
- 개발자가 기능의 작동 방식을 이해할 수 있도록 충분한 정보를 제공합니다.
- DocBlock 주석 형식을 사용하십시오.
실제 사례
/**
* 두 숫자의 평균을 계산하십시오.
*
* @param float $ num1 첫 번째 번호* @param float $ num2 Second Number* @return float 평균*/
기능 평균 (플로트 $ Num1, Float $ Num2) : float
{
반품 ($ num1 + $ num2) / 2;
} 다른 팁
- 코드 스 니펫을 사용하여 기능 사용을 보여줍니다.
- 문서의 관련 기능 또는 클래스를 연결하여 자세한 정보를 제공합니다.
- 코드 가독성을 향상시키기 위해 가능한 한 유형 프롬프트를 제공합니다.
- 정확성과 일관성을 보장하기 위해 문서를 정기적으로 검토하십시오.
