我使用phpdocumentor爲我的項目生成文檔。它產生良好的文檔,我的功能,如:Phpdocumentor和Slim路由器文檔
/**
* 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+'));
什麼是記錄這樣的事情正確的方式?
API使用不是API文檔的一部分。您可以將代碼封裝在一個函數或方法中,並返回結果。 – Daniel