# YesE

**Repository Path**: yond/YesE

## Basic Information

- **Project Name**: YesE
- **Description**: 根据PHP注释自动生成帮助手册.整个项目只有一个文件.
- **Primary Language**: PHP
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2017-02-17
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 夜色PHP文档自动生成工具
---
    * 指定目录下PHP类文件注释自动生成PHP手册.
    * 支持标准PHP注释格式
    * 无需任何操作,代码编写好自动加入手册
    * 团队开发的必备神器
    * 目前只支持类文件及类方法的注释
    * 下一版本将纳入分类查看及函数文件注释生成
>
### 使用参考
    1 .将此文件拷贝到测试环境
    2 .配置好需生产帮助文档代码路径
    3 .开启项目持续集成
    4 .浏览器打开[http://example.com/doc.php]    

---
>
###  注释参考


```php
<?php
namespace app\tst;
/**
 * 测试类
 * 
 * 用于测试PHP注释
 * @package app\tst
 */
class tst
{
    /**
     * 测试
     *
     * 这是一个测试
     * @param array $a 这是参数a
     * @param int $b 这是参数b     
     * @return array ret.c 返回值c
     * @return array ret.d 返回值d
     * @return array ret.e 返回值e
     * @author yond<yondwell@gmail.com>
     * @link http://www.baidu.com
     */
    public  function index($a,$b=1){
        return [
            'c'=>$a[0],
            'd'=>$b,
            'e'=>$a[0].$b
        ];      
    }

}

```

---
>
###  配置参考 
```php
 private static $cfg = [
        'appdir' => './application', //app目录,绝对路径或相对文件路径
    ];

```