All Projects → shixinke → php-document-creator

shixinke / php-document-creator

Licence: other
a document creator for php extension.一个用于生成PHP扩展文档的工具

Programming Languages

PHP
23972 projects - #3 most used programming language

Projects that are alternatives of or similar to php-document-creator

Ant php extension
PHP 扩展, 用于 PHP-FPM、FastCGI、LD_PRELOAD等模式下突破 disabled_functions
Stars: ✭ 85 (+240%)
Mutual labels:  php-extension
Cphalcon
High performance, full-stack PHP framework delivered as a C extension.
Stars: ✭ 10,534 (+42036%)
Mutual labels:  php-extension
xray
X-Ray - PHP Engine compiler hook API (new)
Stars: ✭ 19 (-24%)
Mutual labels:  php-extension
Ip2region
Ip2region is a offline IP location library with accuracy rate of 99.9% and 0.0x millseconds searching performance. DB file is ONLY a few megabytes with all IP address stored. binding for Java,PHP,C,Python,Nodejs,Golang,C#,lua. Binary,B-tree,Memory searching algorithm
Stars: ✭ 9,836 (+39244%)
Mutual labels:  php-extension
Php Rdkafka
Production-ready, stable Kafka client for PHP
Stars: ✭ 1,703 (+6712%)
Mutual labels:  php-extension
Ycdatabase
The lightest php database framework written in c language, built in php extension, for mysql
Stars: ✭ 130 (+420%)
Mutual labels:  php-extension
Gutenberg Parser Rs
An experimental Rust parser for WordPress Gutenberg post format
Stars: ✭ 76 (+204%)
Mutual labels:  php-extension
php-smartcrop-extension
smartcrop implementation in php extension
Stars: ✭ 17 (-32%)
Mutual labels:  php-extension
V8js
V8 Javascript Engine for PHP — This PHP extension embeds the Google V8 Javascript Engine
Stars: ✭ 1,659 (+6536%)
Mutual labels:  php-extension
Php V8
PHP extension for V8 JavaScript engine
Stars: ✭ 197 (+688%)
Mutual labels:  php-extension
Ext Collections
Array manipulation extension for PHP.
Stars: ✭ 94 (+276%)
Mutual labels:  php-extension
Php Akm
Ahocorasick keyword match.
Stars: ✭ 116 (+364%)
Mutual labels:  php-extension
Pht
A new threading extension for PHP
Stars: ✭ 175 (+600%)
Mutual labels:  php-extension
Php Ext Collection
PHP collection extensions - PHP Version 7.x
Stars: ✭ 89 (+256%)
Mutual labels:  php-extension
nanobox-engine-php
Engine for running PHP apps on Nanobox
Stars: ✭ 20 (-20%)
Mutual labels:  php-extension
Php Rs
A library to build PHP extensions in Rust.
Stars: ✭ 81 (+224%)
Mutual labels:  php-extension
Php Zephir Parser
The Zephir Parser delivered as a C extension for the PHP language.
Stars: ✭ 129 (+416%)
Mutual labels:  php-extension
php-mustache
Mustache PHP Extension
Stars: ✭ 55 (+120%)
Mutual labels:  php-extension
php-bencode
C++ PHP extension which can boost the process of encoding and decoding of Bencode.
Stars: ✭ 16 (-36%)
Mutual labels:  php-extension
Php Psr
PHP extension providing the accepted PSR interfaces
Stars: ✭ 189 (+656%)
Mutual labels:  php-extension

phpDocumentCreator

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

english document

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文档

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源码,目前这里列举了yaf,swoole,redis等三个扩展的注释文件

输出(最终的PHP文档)

如果想使用已经生成好的文档,请查看phpstrom框架助手

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

Author

author:shixinke([email protected],[email protected])

website:http://www.shixinke.com

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].