xeoncross/pocco

PHP 文档生成器(Docco 克隆版)

安装: 32

依赖: 0

建议: 0

安全性: 0

星标: 5

关注者: 3

分支: 2

语言:JavaScript

dev-master 2013-07-25 17:26 UTC

This package is not auto-updated.

Last update: 2024-09-14 15:21:44 UTC


README

使用您现有的源代码生成 PHP 文档的生成器!基于出色的 Docco JavaScript 文档生成器(但针对 PHP 进行了改进!)。

示例

首先,您需要使用 Composer 安装库。在文档文件夹中创建一个 composer.json 文件,并输入以下内容:

{
	"require": {
		"xeoncross/pocco": "dev-master"
	}
}

创建 composer.json 文件后,您就可以安装 Pocco。

$ composer install

接下来,创建一个 index.php 文件,并包含并运行 Pocco。

<?php

// Include Directly
//require('pocco/src/Xeoncross/Pocco.php');

// or with Composer (recomended)
require('vendor/autoload.php');

$dir = realpath('/var/www/path/to/project/') . '/';
$default_file_to_show = null;
$requested_file_to_show = isset($_GET['file']) ? $_GET['file'] : null;

$pocco = new Xeoncross\Pocco;

if( ! $pocco->display($dir, $default_file_to_show, $requested_file_to_show)) {

	header('HTTP/1.0 404 Not Found');
	die("404 - File not Found");

}

David Pennington 创建