Laravel 4 용 PHP 문서화 코드

Question

phpDoc에 작성한 코드 만 문서화하고 싶습니다. 나는 MVC 프레임 워크로 Laravel 4을 사용하고 있습니다. 문서의 모든 호출 루틴 (예 : routes.php)과 함께 코드를 문서화 할 수 있도록 코드를 구조화하는 좋은 방법은 무엇입니까? Laravel 내부에서 MVC 아키텍처 전체를 문서화하고 싶지는 않습니다.

또한 함수 호출을 phpDoc에 문서화 할 수 있습니까?

Answer 1

phpDoc은 언제 어디서나 OOP를 위해 사용할 수 있습니다.

우리는 OOP에 대해 이야기 할 때 함수를 메서드로 호출하지만 MVC에서는 함수를 작업으로 호출합니다. 그러나, Laravel jQuery를 유사 익명 함수를 사용의

/** 
* Returns Hello, $name 
* 
* @param string $name 
*/ 
function hello($name) { 
{ 
    printf('Hello, %s', $name); 
} 

경로 :이 기능을 사용하려면

<?php 
/** 
* @method int sum($a, $b) 
* @license GPL 
* @license http://opensource.org/licenses/gpl-license.php GNU Public License 
* @author Your Name <your@email.com> 
*/ 
class Calc 
{ 
    /** 
    * Sums the first value with the second value 
    * 
    * @param int|float $a //First Param 
    * @param int|float $b //Second Param 
    * @example echo sum(2, 3); //returns 5 
    * @since 1.1 //Version 
    * @return int|float $result //Value Returned (use void if doesn't return) 
    */ 
    public function sum($a, $b) 
    { 
     /** 
      * @todo Needs implement validation 
      */ 

     return $result = $a + $b; 
    } 
} 

, 당신은 같은 패턴을 따른다 : 어떤 경우에 당신은이 패턴을 따를 수

을 : 함수의 이름을 제공 할 수 있고 나중에 호출

/** 
* Route for user 
* 
* @uses Route::get() 
* @example http://url.com/user/john 
* @param string $name 
*/ 
Route::get('user/{name?}', function($name = 'John') 
{ 
    return $name; 
}); 

더 문서화 된 방법 : 당신은 또한하는 PHPDoc을 사용할 수 있어야합니다 공식 웹 사이트에서 5,

/** 
* Route for user 
* 
* @uses Route::get() 
* @example http://url.com/user/john 
* @param string $name 
*/ 
function route_user_name($name = 'John') 
{ 
    return $name; 
}); 

Route::get('user/{name?}', route_user_name($name)); 

확인 더 : http://www.phpdoc.org/

PS : https://github.com/SublimeText/PhpDoc