README

docBloc - 从composer.json和Git数据中生成并保持项目文件docBlock的更新。支持的文件类型：*.php, *.ini, *.sh, *.bat, *.md（使用此工具无需安装Composer或PEAR）。

Composer.json 示例

docBloc从composer.json获取项目详细信息。如果您的项目还没有一个，请按照以下示例创建它，并将其放置在项目根路径中。

{
    "name": "intrd/docbloc",
    "description": "PHP docBloc - Generate and keep updated docBlock of your project files fetching details from composer.json and Git. Supported filetypes: *.php, *.ini, *.sh, *.bat, *.md (No Composer or PEAR need to be installed to use this tool).",
    "keywords": ["php","docblock","documentation","tool"],
    "homepage": "http://github.com/intrd/docbloc",
    "authors": [
            {
                "name": "intrd (Danilo Salles)",
                "email": "x@dann.com.br",
                "homepage": "http://dann.com.br",
                "role": "Developer"
            }
        ],
    "license": "CC-BY-SA-4.0",
    "require": {
        "php": ">=5.3.0"
    },
    "autoload": {
        "psr-4": {
            "php\\":"src/"
        }
    },
    "extra": {
        "author_twitter":"intrd",
        "copyright_author":"intrd",
        "license_title":"Creative Commons Attribution-ShareAlike 4.0",
        "license_url":"http://creativecommons.org/licenses/by-sa/4.0"
    }
}

Docbloc 触发器

每种文件类型都有自己的触发器，将其放在您希望docBloc管理的文件的头部。

PHP - 脚本

/** @docbloc **/

INI - 配置文件

;; @docbloc ;;

SH - Shell 脚本

## @docbloc ##

BAT - 批处理脚本

REM @docbloc REM

MD - Markdown文件，如README.md

<!-- @docbloc -->

Git详细信息

(可选) 我建议您通过Git分支名称来控制项目的版本。这是可选的，但docbloc会从.git/HEAD中获取版本。如果您的项目没有使用Git，docbloc将不会在文件中显示版本字段。

用法

假设您已经

PHP运行正常
创建/编辑了您的composer.json
在所有文件中添加了正确的docBloc触发器
(可选) 一个正常工作的.git/HEAD

现在转到您的项目根目录并运行

$ wget -O docbloc.php https://raw.githubusercontent.com/intrd/docbloc/1.1/src/docbloc.php && php docbloc.php && rm docbloc.php

它将下载docbloc.php脚本，运行并删除它。

完成，每次您在composer.json中更改任何项目详细信息或创建一个新的git branch版本时，只需再次运行docBloc即可保持所有文件docbloc头部的更新。是的，它也可以在上级目录级别上递归工作。

intrd / php-docbloc

维护者

详细信息

README

Composer.json 示例

Docbloc 触发器

Git详细信息

用法