PHPackages                             shixinke/php-document-creator - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [PDF & Document Generation](/categories/documents)
4. /
5. shixinke/php-document-creator

ActiveLibrary[PDF & Document Generation](/categories/documents)

shixinke/php-document-creator
=============================

a document creator for php extension

23153PHP

Since Dec 14Pushed 6y ago4 watchersCompare

[ Source](https://github.com/shixinke/php-document-creator)[ Packagist](https://packagist.org/packages/shixinke/php-document-creator)[ RSS](/packages/shixinke-php-document-creator/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

phpDocumentCreator

===============

[english document](https://github.com/shixinke/php-document-creator/blob/master/README_en.md)

phpDocumentCreator是一个用于生成PHP扩展文档的类库.因为PHP的扩展是使用C语言编写的，所以我们没办法直接查看扩展函数或扩展类库的用法，只能通过查看C源码来了解。我们通过PHP的反射类库列出某个PHP扩展的常量、函数、类常量、属性和方法，然而有时反射类库不能显示完整的信息，而且这些类库没有注释，所以为了弥补这个缺陷，我们可以通过自定义的数据字典为这些扩展类库添加注释，或者我们通过已有PHP代码为这些扩展类库添加注释

安装
--

[](#安装)

1、 通过从github上clone代码

```
git clone https://github.com/shixinke/php-document-creator

```

2、 通过composer安装

 composer require shixinke/php-document-creator

基本用法
----

[](#基本用法)

### create php document 生成PHP文档

[](#create-php-document-生成php文档)

usage : php creator.php extensionName create

```
php creator.php swoole create

```

### 创建字典

[](#创建字典)

```
require_once '../Autoloader.php';
//Redis为扩展的名称
$doc = new \documentCreator\Document('Redis');
$doc->createDict();

cd tests
php docTest.php

```

### 其他说明

[](#其他说明)

#### 字典

[](#字典)

包含PHP扩展的函数、常量和类常量、属性和方法的说明(主要是类型说明，参数说明和注释)

这里自带了yaf,swoole,redis这三个扩展的字典

#### 备注(PHP源代码)

[](#备注php源代码)

带有注释的PHP源码，目前这里列举了yaf,swoole,redis等三个扩展的注释文件

#### 输出(最终的PHP文档)

[](#输出最终的php文档)

如果想使用已经生成好的文档，请查看[phpstrom框架助手](https://github.com/shixinke/php-ide-helper)

如果有好的注释文件请push给我

Author
------

[](#author)

author:shixinke(,)

website:

###  Health Score

22

—

LowBetter than 22% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity16

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity35

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/af0b3b3b7c6d494861ea002649dccd189869478f47cc40ff8bb7999e8fff962b?d=identicon)[shixinke](/maintainers/shixinke)

---

Top Contributors

[![shixinke](https://avatars.githubusercontent.com/u/9602010?v=4)](https://github.com/shixinke "shixinke (71 commits)")

---

Tags

phpphp-documentationphp-extension

### Embed Badge

![Health badge](/badges/shixinke-php-document-creator/health.svg)

```
[![Health](https://phpackages.com/badges/shixinke-php-document-creator/health.svg)](https://phpackages.com/packages/shixinke-php-document-creator)
```

###  Alternatives

[phpoffice/phpspreadsheet

PHPSpreadsheet - Read, Create and Write Spreadsheet documents in PHP - Spreadsheet engine

13.9k293.5M1.2k](/packages/phpoffice-phpspreadsheet)[spatie/browsershot

Convert a webpage to an image or pdf using headless Chrome

5.2k32.1M100](/packages/spatie-browsershot)[smalot/pdfparser

Pdf parser library. Can read and extract information from pdf file.

2.7k34.5M216](/packages/smalot-pdfparser)[barryvdh/laravel-snappy

Snappy PDF/Image for Laravel

2.8k24.8M48](/packages/barryvdh-laravel-snappy)[openspout/openspout

PHP Library to read and write spreadsheet files (CSV, XLSX and ODS), in a fast and scalable way

1.1k57.6M129](/packages/openspout-openspout)[keboola/csv

Keboola CSV reader and writer

1451.8M21](/packages/keboola-csv)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)