phpDoc을 통해 함수 내에서 변수를 문서화하는 방법

PHP 문서에 주석을다는 데 PHPDoc 표준을 사용하고 API 문서를 생성하려면 ApiGen을 사용하고 있습니다.phpDoc을 통해 함수 내에서 변수를 문서화하는 방법

정보를 제공하는 데 사용할 수있는 태그가 많이 있다는 것을 알고 있습니다.

define() 문, 함수, 클래스, 클래스 메서드 및 클래스 vars, include() 문 및 전역 변수는 모두 문서화 할 수 있습니다.

하지만 지금은 함수에있는 변수를 문서화하려고합니다. 이 경우에 대한 해결책이

  /** 
     * @param Request $request 
     * @param   $course_id 
     * @param   $lesson_id 
     * @param Content $content 
     * 
     * @return array 
     * 
     */ 
     public function SaveOnePageTest (Request $request, $course_id, $lesson_id, \App\Content $content) 
     { 
      /** 
      *I want to document this variable that how does this and What used to be? 
      */ 

      $doneTest = DoneTest::find($done_test_id); 

      /** 
      *or this variable 
      */ 
      $parentQuestions = $doneTest->parent_test->questions; 
     }

있습니까 : 예를 들어
내가이 같은 함수가 있다고 가정?

출처

2016-07-18 A.B.Developer

여기에는 "형식화 된"방법이 없습니다. 사용자가 원하는 주석을 추가하기 만하면됩니다. –

간단한 설명을 사용하면 최종 API 설명서의 함수 내 변수에 대한 정보를 만들 수 없습니다. –

그럴 수는 없지만 최종 사용자는 방법의 내부에 대해 알아야합니까? –

이러한 종류의 문서화 도구/구문은 라이브러리/소프트웨어 API를 사용하는 사람들을 돕기 위해 개발되었습니다.

로컬 변수에 최종 사용자가 액세스 할 수 없으므로 설명서에 실제 변수를 표시 할 필요가 없습니다.

내부 코드를 문서화 할 수 있지만 PHPDoc을 사용하여이를 수행하는 표준 방법은 없습니다.

출처

2016-07-18 08:30:54 n00dl3

그러나 로컬 변수를 문서화하는 방법은 없습니까? 왜 나는 커다란 프로젝트에서 일하고 있으며 클래스, 변수, 메소드 등을 기억하는 문서를 만들고 싶습니다. –

로컬 변수에 대한 일반 주석을 사용하십시오. 로컬 변수와 상호 작용할 필요가있는 경우 코드를 열어야합니다. – n00dl3

phpDoc을 통해 함수 내에서 변수를 문서화하는 방법

답변

관련 문제