用薩米生成PHP文檔

sami：一個強大的API文檔生成器，用於PHP

>為您的PHP方法，類和功能生成單獨的文檔是最佳實踐。 本文介紹了SAMI，這是一個強大的API文檔生成器，可簡化此過程，改善可讀性和可訪問性。

> sami的關鍵特徵：

>

生成用於PHP代碼的獨立文檔，消除了直接導航源代碼的需求。

>通過Phar Archive或Composer輕鬆安裝。
• 通過PHP配置文件高度配置，允許自定義主題，標題，構建目錄和緩存。
• 支持自定義主題和資產包含，以獲得個性化的外觀。
與Git版本控件集成，為多個代碼庫版本啟用文檔。
• 理解docblocks：
對薩米人至關重要。它們是將類，接口，方法或屬性定義放置的多行註釋。 這是一個laravel示例：

> dicblocks以開頭，以

結尾，而內的每一行均以

開始。

和

abstract class Manager
{
    /**
     * The application instance.
     *
     * @var \Illuminate\Foundation\Application
     */
    protected $app;

    /**
     * Create a new manager instance.
     *
     * @param \Illuminate\Foundation\Application $app
     * @return void
     */
    public function __construct($app)
    {
        $this->app = $app;
    }
}

等註釋提供了其他信息。 phpdocumentor的註釋標準得到了廣泛支持。

> /** */ sami vs.其他發電機：*@param> @var雖然存在其他發電機（例如，phpdocumentor），但由於其github集成和twig模板能力而脫穎而出。

>

>安裝sami：>

選擇以下方法之一：

PHAR檔案：下載

和運行​​

。

>。

>
1. > Composer：>使用將SAMI添加到您的項目中。 然後運行sami.phar。 php sami.phar
2. composer require sami/sami:3.0.*php vendor/sami/sami/sami.php生成Laravel文檔（示例）：
>

克隆laravel框架：

>

創建一個文件（請參閱下面的配置部分）。 >

>運行：

1. git clone git@github.com:laravel/framework.git docs
2. configuration（config/config.php）：
3. 此文件返回aphp vendor/sami/sami/sami.php update config/config.php實例：

運行更新命令後，啟動php服務器（），然後訪問config/config.php>的文檔。

> git版本：

Sami在處理多個GIT版本方面表現出色。 將

選項添加到您的配置：versions

abstract class Manager
{
    /**
     * The application instance.
     *
     * @var \Illuminate\Foundation\Application
     */
    protected $app;

    /**
     * Create a new manager instance.
     *
     * @param \Illuminate\Foundation\Application $app
     * @return void
     */
    public function __construct($app)
    {
        $this->app = $app;
    }
}

記住在

和%version%>中包括build_dir。 cache_dir

創建自定義主題：

SAMI允許創建自定義主題。 將一個文件放在主題目錄中（例如

）：>

然後，修改manifest.yml模板以包含您的CSS。更新您的配置文件以使用您的自定義主題：themes/mytheme/manifest.yml。 運行

以重新生成文檔。

$dir = __DIR__ . '/../docs';

$iterator = Symfony\Component\Finder\Finder::create()
    ->files()
    ->name('*.php')
    ->exclude('build')
    ->exclude('tests')
    ->in($dir);

$options = [
    'theme'                => 'default',
    'title'                => 'Laravel API Documentation',
    'build_dir'            => __DIR__ . '/../build/laravel',
    'cache_dir'            => __DIR__ . '/../cache/laravel',
];

$sami = new Sami\Sami($iterator, $options);

return $sami;

base.twig 'theme' => 'mytheme' sami render config/config.php --force

結論：

Sami提供了一種強大而靈活的解決方案，用於為您的PHP項目生成高質量的API文檔。 它的功能，包括GIT版本控制和自定義主題支持，使其成為任何PHP開發人員的寶貴工具。 完整的示例可在GitHub上找到（如果為此示例存在GitHub存儲庫，則可以在此處添加鏈接）。

以上是用薩米生成PHP文檔的詳細內容。更多資訊請關注PHP中文網其他相關文章！