PHP 코드 인라인 문서에는 여러 가지 표준이 있습니다.PHP 함수와 클래스를 인라인으로 문서화하려면 어떻게해야합니까?
/**
* This is the description for the class below.
*
* @package my-package
* @subpackage my-subpackage
* @author my-name
* @version my-version
* ...
*/
class orderActions {
...
인라인 문서의 제일과 가장 널리 인정 형태는 무엇입니까 : 여기 인라인 문서에 의해 의미, 더 나은 용어가있는 경우 나 수정하시기 바랍니다 무엇입니까? 그러한 문서를 자동으로 생성 할 수있는 도구가 있습니까? 아니면 직접 작성해야합니까?
설명서를 생성하는 데 관심이 없습니다. 위에서 언급 한 코드 유형을 생성하는 방법이나 "인라인 설명서"를 알고 싶습니다.
PHPDoc은 게시 한 것과 마찬가지로 널리 인정되는 PHP 문서 형식입니다.
Doxygen을 사용하면 문서를 자동으로 생성 할 수 있습니다.
편집 : 코드에서 인라인 문서를 생성하는 측면에서 필자는 프로젝트를 위해 외부로 돌아갈 도구를 찾지 못했습니다. 일반적으로 코드를 작성하는 동안 IDE의 영역에 템플릿이 생성됩니다.
이클립스는 실제로 Eclipse에 대해 내가 좋아하는 몇 안되는 것들 중 하나입니다. Eclipse는 Netbeans도 마찬가지라고 생각합니다. 모든 주요 IDE에는 이러한 유형의 템플릿 생성을 지원하는 기능이있을 것입니다.
PHP 문서를 추가하는 가장 일반적인 방법은 PHPDocumentor가 가장 일반적입니다. –
PHPDoc을 사용하여 인라인 문서를 생성 할 수 있습니까? 나는 그것이 설명서만을 생성하는 것이라고 생각했다. –
+1 정말 잘 작동하고 넷빈과 통합됩니다. –
비록 완전히 활용하지는 않았지만, Doxygen이이 작업에 유망 해 보입니다.
Java 용 JavaDoc 도구에 익숙하다면 매우 유사합니다. Doxygen 스타일을 사용하고 문서를 만들기 위해 소스 파일 위에 도구를 실행합니다.
일반적으로 일부 IDE는 템플릿을 만들 수 있다고 생각하지만 실제로는 docblock 주석을 직접 작성해야합니다.
실제로는 write a program, which can trace a running program and detect parameter types and write them back as docblock comments입니다. 그것은 다소 버그가 있지만 일종의 것입니다.
코드가 무엇인지 모르겠지만 (내가 사용하고있는 Textmate를 사용하여) 코드 조각을 몇 개 가지고 있습니다. 세부 사항을 채우고 있기 때문에 최상의 결과를 얻었습니다. 나를 위해 그것을 할 시스템을 신뢰하는 대신에.
그것은 시작에 더 많은 작업이다하지만 내가 매우 간단하고 사용하기하는 PHPDoc와 호환 documentator 만들어
장기적으로 가치가있을 것 같다 :
예 :
<?php
$docs = new QuickDocumenter();
$docs->parseString("
/**
* Sanitize string
*
* @sinse 1.0
* @version 1.0
*/
");
foreach($docs->result() as $doc)
{
highlight_string(print_r($doc , true));
echo "<hr/>";
}
?>
Github에서를 참조하십시오 :
안녕!
@ sinse의 철자는 @since : '이어야합니다. –
최근 편집으로 무엇을 의미합니까? 나는 당신이 "이 인라인 문서를 생성하는 방법"이란 의미를 얻지 못한다. –
죄송합니다, 명확하게 : 예제에서 코드 주석 형식 (또는 "인라인 설명서")을 생성하는 방법을 묻습니다. –