# FizeDoc

**Repository Path**: fizechan/FizeDoc

## Basic Information

- **Project Name**: FizeDoc
- **Description**: PHP 文档生成器
- **Primary Language**: PHP
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2021-04-22
- **Last Updated**: 2021-11-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Documentation Status](https://readthedocs.org/projects/fizedoc/badge/?version=latest)](https://fizedoc.readthedocs.io/zh_CN/latest/?badge=latest)

# FizeDoc
PHP 文档生成器

开发者最讨厌的两件事：
写文档！
别人不写文档！

“我代码已经足够优美，看代码，哪里还需要什么文档！”、“没有文档让我看什么代码！”，诸如这类的吵架式话题可以在 FizeDoc 终结了！

FizeDoc 解析 PHP 源代码，提取相关代码及注释，生成类库参考文档。

通过生成 ReStructuredText 、Markdown 或者其他标准文档类型，您不再需要编写任何类库文档，只需稍微添加那些必需的描述性文档即可完成文档编写工作。

FizeDoc 需要您的代码注释满足 [ PHPDoc ](https://docs.phpdoc.org/references/phpdoc/index.html) 规范，相信这个对于代码有处女座情节的您来说不是什么难事！

FizeDoc 自身的文档也是通过 FizeDoc 来生成的，Fize 的各个子项目文档也都使用 FizeDoc 来生成。

以前您需要管理文档，现在您只需要管理代码注释即可，剩下的时间就用来陪好基友或者女朋友吧！~


项目GitHub : [ https://github.com/fizechan/FizeDoc ](https://github.com/fizechan/FizeDoc)

参考手册 : [ https://fizedoc.readthedocs.io/zh_CN/latest/index.html ](https://fizedoc.readthedocs.io/zh_CN/latest/index.html)