Download the PHP package sunanzhi/annotateddoc without Composer
On this page you can find all versions of the php package sunanzhi/annotateddoc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.
Example:
Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories.
In this case some credentials are needed to access such packages.
Please use the auth.json textarea to insert credentials, if a package is coming from a private repository.
You can look here for more information.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?
Informations about the package annotateddoc
annotatedDoc
php 注释自动生成文档
效果链接
http://annotateddoc.sunanzhi.com/doc/index.php?module=makeup&class=Product&method=list
安装方式
composer require sunanzhi/annotateddoc
使用方式
在public文件夹下新建doc文件夹，doc文件夹命名一个index.php文件（这一步支持随意化，看项目的路径访问）
使用包内案例
配置Config说明
| key | type | desc |
|---|---|---|
| defaultModule | string | 默认模块 例：example |
| defaultClass | string | 默认类 |
| defaultMethod | string | 默认方法 |
| moduleList | array | 模块列表 |
| moduleList.path | string | 模块的绝对路径 例：/Users/MorsTiin/sites/annotatedDoc/app/example/api |
| moduleList.namespace | string | 模块下接口的命名空间 例：app\\example\\api |
| moduleList.name | string | 模块名 例：example |
| staticUrl | array | 样式链接，考虑到使用者可能用自己项目的layui/jq |
| staticUrl.jqueryPath | string | jquery路径 例：https://cdn.bootcss.com/jquery/3.4.1/jquery.min.js |
| staticUrl.layuiJsPath | string | layuiJs路径 例：https://www.layuicdn.com/layui-v2.5.6/layui.js |
| staticUrl.layuiCSSPath | string | layuiCSS路径 例：https://www.layuicdn.com/layui-v2.5.6/css/layui.css |
| availableTags | array | 默认可用标签 |
| extraTags | array | 拓展标签 |
tags 列表
| 标签名 | 描述 | 是否支持多个 |
|---|---|---|
| param | 请求参数 | 是 |
| resParam | 返回字段 | 是 |
| requestUrl | 请求url | 否 |
| requestExample | 请求示例 | 是 |
| returnExample | 返回示例 | 是 |
| table | 表格 | 是 |
| author | 作者 | 否 |
| since | 创建时间 | 否 |
| link | 引用链接 | 是 |
| changeLog | 变更记录 | 是 |
| rank | 权限 | 否 |
注解tag
@param 参数，支持多个
使用方式
@resParam 返回结果字段，支持多个
使用方式
@requestUrl 请求链接
使用方式
注意：如果不填写默认按照 模块/类名/方法 方式显示，也可以实现 requestUrlCallBack 来显示自己的请求规则
@table 表格类型，支持多个
使用方式
@requestExample 请求示例，支持多个
使用方式 json数据格式
@returnExample 返回示例，支持多个
使用方式 json数据格式
@author 作者
使用方式
@since 接口创建时间
使用方式
@link 参考链接，支持多个
使用方式
@changeLog 变更日志，支持多个
使用方式
一个简单示例，仅供参考，如有问题邮件或发布issue
All versions of annotateddoc with dependencies
PHP Build Version
Package Version
The package sunanzhi/annotateddoc contains the following files
Loading the files please wait ....