3

プロジェクトのドキュメントを生成するためにphpdocumentorを使用しています。次のような関数の適切なドキュメントを生成します。

    /**
       * Hash generator
       *
       * Long description
       *
       * @param string $password Password
       * @return string
       */
    function generate_hash($password) {
        global $PASSWORD_SALT;
        return crypt($password, $PASSWORD_SALT);
    }

しかし、スリム（phpフレームワーク）のマッピングを文書化する方法が見つかりませんでした：

    /**
     * Delete news
     *
     * Delete news by id
     *
     * @link /news/delete/:id
     *
     */
    $app->get('/news/delete/:id', function ($id) use ($app) {
        $item = ORM::for_table('news')->find_one($id);
        if ($item)
            $item->delete();
        $app->redirect('/');
    })->conditions(array('id'=>'\d+'));

このようなことを文書化する正しい方法は何ですか?

4

1 に答える 1

0

私のコメントを答えとして説明するために、次のようなものを紹介します。

/**
 * Delete news
 *
 * Delete news by id
 *
 * @link /news/delete/:id
 *
 */
public function deleteNewsByID (&$app, $id)
{
     return $app->get('/news/delete/:id', function ($id) use ($app) {
         $item = ORM::for_table('news')->find_one($id);
         if ($item)
             $item->delete();
         $app->redirect('/');
     })->conditions(array('id'=>'\d+'));
}

しかし、私はスリムに慣れていないので、これがまったく機能することを保証することはできません. 以下のコメントで述べられているように、それは推奨されておらず、きれいでもありません。

于 2013-01-07T14:54:23.420 に答える