如何创建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');

参数

路由参数是用@param name 描述定义的，可以在资源类型路由中使用@param。

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