如何创建laravel项目的文档？

Question

我在Laravel上有一个简单的网站，有不同类型的条目和类别。 我需要为他创建文档。 我试图安装phpDocumentor，但它没有安装在Laravel最新版本上。 另外我应该澄清，这不是一个简单的网站项目的API。 您还有哪些其他解决方案可以自动生成文档？

Answer 1

如果您想为路线创建文档，可以尝试laravel-routes。

这个软件包可以与composer一起安装下一个命令：

composer require gussrw/laravel-routes

您可以使用下一个artisan命令从控制台生成html文件。

php artisan route:docs

此命令在Project / docs中创建一个html文件。

路线说明

描述是可选的，但如果你想添加它们，可以使用@description在web.php文件中的每个路径上创建一个php注释。

/**
 * @description Show the home page of the site
 */
Route::get('/home', 'HomeController@index') -> name('home.index');

资源路线

资源类型路由中的描述由它们在控制器中的方法标识。

/**
 * @index Show the main view
 * @create Show the view to create a photo
 * @store Save a photo in database
 * @edit Show the view to edit a photo
 * @update Update photo data in database
 * @destroy Delete a photo in database
 */
Route::resource('photos', 'PhotoController');

<强> PARAMS

路由参数用@param名称描述，您可以在资源类型路由中使用@param。

/**
 * @description Download photo with the photo id.
 * @param id ID of the photo in database
 */
Route::get('/photo/{id}/download', 'PhotoController@download');