일부 레거시 코드에 몇 가지 코멘트를 달았습니다. PHPDocumentor를 사용하여 작은 문제를 해결했습니다.PHPDocumentor - 내 DocBlock의 문제점은 무엇입니까?
다음은 예입니다 :
/**
* Constructs the Widget object
*
* Basic constructor for the widget object.
* Another line of pointless explanation, badly worded.
*
* @param string $id The ID of the widget
* @param int $size The Size of the widget
* @return void
* @throws InvalidArgumentException
*/
public function __construct($id, $size) {
if (!is_string($id) || !is_integer($size)) {
throw new InvalidArgumentException('$id must be a string, $size an integer');
}
$this->id = $id;
$this->size = $size;
}
내가 명령 줄에서 PHPDocumentor을 실행하고 문서의 전체 사랑스러운 폴더 얻을.
문서는 잘 보이지만, 나는의 라인을 따라 PHPDocumentor 컴파일 오류 얻을 :
Argument $id is missing from the Docblock of __construct
은 그냥 PHPDocumenator 불필요하게 징징인가를, 또는 내가 부족 분명 뭔가가있다?
해당 파일을 가리키고 있습니까? – Cheery
그래! 문서 자체가 완성되었지만 errors.html 파일에 오류가 발생했습니다. – Dycey
ASCII가 아닌 다른 키보드 레이아웃에 글자를 입력 할 수 있습니까? – Cheery