한국어
한국어
composer init
프롬프트를 따라 설정을 완료하고 Composer.json 파일에 다음 내용을 추가하십시오.
{
"require-dev": {
"phpdocumentor/phpdocumentor": "~3.0"
},
"scripts": {
"docs": "vendor/bin/phpdoc -d ./src -t ./docs"
}
}
Composer.json 파일을 저장하고 닫습니다. 다음으로 PhpDocumentor를 설치하려면 터미널에서 다음 명령을 실행하십시오.
composer install
이렇게하면 모든 종속성을 설치하고 필요한 라이브러리 파일을 공급 업체 디렉토리에 추가합니다.
/**
* 这是一个示例类
*
* @package MyApp
*/
class ExampleClass {
/**
* 示例方法
*
* @param int $param1 参数1的描述
* @param string $param2 参数2的描述
* @return bool 返回类型的描述
*/
public function exampleMethod( $param1 $param2 ) { ,
// 方法的实现代码
}
}
실제 조건에 따라 코드에 적절한 주석을 추가하여 문서가 코드와 일치하는지 확인하십시오.
composer docs
이 명령은 코드에서 주석을 구문 분석하고 API 문서를 생성합니다. 생성 된 문서는 DOCS 디렉토리에 저장됩니다.
Composer.json 파일을 열고 "스크립트" 끝에서 다음을 추가하십시오.
"post-commit": [
"@docs"
]
이러한 방식으로 API 문서를 생성하라는 명령은 각 코드 제출 후에 자동으로 실행됩니다.
