CodeIgniter에 phpDocumentor를 사용하는 방법

Question

저는 방대한 웹 응용 프로그램을 구축했으며 주석 처리 방법을보기 위해 CodeIgniter (CI)의 스타일 가이드를 살펴 보았습니다.

이 괜찮습니다하지만 나는이 옵션을 작성 해야할지 모르겠어 : 그것은 클래스와 메소드에 대해이 같은 일이있다. 나는 실제로 @package를 가지고 있지 않다. 나는 모델과 컨트롤러를 갖고있다. Java에서는 보안을 위해 패키지를 사용할 수 있지만 CI가 아닌 패키지는 MVC 일뿐입니다. 나는 항상 project_mode, projects (컨트롤러), add_project_view.php 같은 것을 가지고있다.

또한 @category의 형식은 무엇입니까? phpDocumentor 또는 docs는 "@category 태그는 패키지 그룹을 함께 구성하는 데 사용됩니다"라고 말합니다. 다시, 패키지 없음!

두 번째로, 메소드의 매개 변수는 무엇입니까? 때때로 두 개의 문자열과 배열 또는 정수와 배열을 가지고 있는데, @param의 형식은 무엇입니까?

감사합니다,

Answer 1

패키지, 서브 패키지와 범주는 논리적으로 코드를 구조화 더 나은입니다. 당신이 가진 모든 프로젝트/코드 파일을 위해 거기에있을 필요는 없습니다.

반면에 메소드의 Params는 코드에서 해당 메소드를 호출하는 동안 전달해야하므로 문서를 읽을 때 무엇인지 알고 있어야하므로 메소드 정의에서 매우 유용합니다.

샘플은과 같이 될 것이다 :

/** 
* Sample function 
* @param string $param1 name of person 
* @param integer $param2 age of person 
* @return string 
*/ 
function person($name, $age) 
{ 
    return "$name is $age years old"; 
} 

Answer 2

@package 만 절차 페이지 또는 클래스를 문서화하는 데 사용할 수 있습니다.

패키지는 논리적으로 관련 요소를 그룹화하는 데 사용됩니다. 관련 함수와 데이터를 함께 그룹화하는 클래스를 작성하고 phpDocumentor는 파일 (함수, 정의, 포함)의 내용을 "절차 페이지"로 나타냅니다. 패키지는 클래스와 절차 페이지를 함께 그룹화하여 디렉터리가 관련 파일을 함께 그룹화하는 방식으로 그룹화하는 데 사용됩니다.

당신은 phpDocumentor 가이드에 PARAMS에 도움을 here