Laravel 4 在 phpDoc 中记录代码

Question

我只想记录我在 phpDoc 中编写的代码。我正在使用 Laravel 4 作为我的基础 MVC 框架。什么是构建代码的好方法，以便我能够在文档中记录我的代码以及所有调用例程（例如，routes.php）。很明显，我不想在 Laravel.

中记录整个 MVC 架构

此外，是否可以记录 phpDoc 中的函数调用？

Answer 1

phpDoc随时随地都可以用，专为OOP设计。

当我们谈论 OOP 时，我们将函数称为方法，但是，在 MVC 中，我们通常将函数称为操作。在任何情况下，您都可以遵循以下模式：

<?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;
     }
}

如果要在函数上使用，请遵循相同的模式：

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

Laravel 的路由使用匿名函数，类似于 jQuery，但是，您应该也可以使用 PhpDoc：

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

一种更有据可查的方法，可以为您的函数命名并稍后调用：

/**
 * 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：大多数 IDE 或文本编辑器都有插件（扩展），可以像 Sublime Text 一样简单：https://github.com/SublimeText/PhpDoc

Laravel 4 在 phpDoc 中记录代码

Documenting code in phpDoc for Laravel 4

php

documentation

phpdoc

laravel-4