如何创建laravel项目的文档?
我在Laravel上有一个简单的网站,有不同类型的条目和类别。 我需要为他创建文档。 我试图安装phpDocumentor,但它没有安装在Laravel的最新版本上。 此外,我应该澄清,这不是一个简单的网站项目的API。如何创建laravel项目的文档?,laravel,Laravel,我在Laravel上有一个简单的网站,有不同类型的条目和类别。 我需要为他创建文档。 我试图安装phpDocumentor,但它没有安装在Laravel的最新版本上。 此外,我应该澄清,这不是一个简单的网站项目的API。 您还有哪些自动生成文档的解决方案?如果您想为路线创建文档,可以尝试 此软件包可以通过下一个命令与composer一起安装: composer require gussrw/laravel-routes 您可以使用下一个artisan命令从控制台生成HTML文件 php art
您还有哪些自动生成文档的解决方案?如果您想为路线创建文档,可以尝试 此软件包可以通过下一个命令与composer一起安装:
composer require gussrw/laravel-routes
您可以使用下一个artisan命令从控制台生成HTML文件
php artisan route:docs
此命令在Project/docs中创建HTML文件
路线描述
描述是可选的,但如果要添加它们,请在web.PHP文件中的每个路由上创建一个PHP注释,并使用@description
/**
* @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');
参数
路由参数是用@param name Description定义的,您可以在资源类型路由中使用@param
/**
* @description Download photo with the photo id.
* @param id ID of the photo in database
*/
Route::get('/photo/{id}/download', 'PhotoController@download');
@description内容未显示在routes.html视图中。有什么解决办法吗