# doc-builder

**Repository Path**: joncc/doc-builder

## Basic Information

- **Project Name**: doc-builder
- **Description**: 文档生成器
- **Primary Language**: PHP
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://gitee.com/joncc/doc-builder
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-01-07
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# doc-builder

#### 介绍
文档生成器

#### 使用说明

1.文档注释格式

FileParse::getDocDome()
```
   /**
    * @doc    #error message
    * @access public
    * @param  errno      #error number
    * @param  errstr     #error message
    * @param  errfile    #error file
    * @param  errline    #error line
    * @return void
    * @throws ErrorException
    */
```

2.文档解析

FileParse::testRegDocProps()
```
Array
(
    [0] => Array
        (
            [0] => doc
            [note] => error message
        )
    [1] => Array
        (
            [0] => access
            [1] => public
        )
    [2] => Array
        (
            [0] => param
            [1] => errno
            [note] => error number
        )
    [3] => Array
        (
            [0] => param
            [1] => errstr
            [note] => error message
        )
    [4] => Array
        (
            [0] => param
            [1] => errfile
            [note] => error file
        )
    [5] => Array
        (
            [0] => param
            [1] => errline
            [note] => error line
        )
    [6] => Array
        (
            [0] => return
            [1] => void
        )
    [7] => Array
        (
            [0] => throws
            [1] => ErrorException
        )
)
```

3.类
* FileParse文件解析类
* DirParse目录解析类

#### 地址
https://gitee.com/joncc/doc-builder