包简介

DocumentPHP is a PHP Helper Package for preparing Documentation

README 文档

README

DocumentPHP

What is DocumentPHP?

DocumentPHP is an application that is capable of analyzing your PHP source code and fetch the files for making API Documentation Data. Currently Tested and working with Opencart Default API's.

DocumentPHP v0.0.2 (Test)

v0.0.2 is the developmental release.

Features

DocumentPHP supports the following:

PHP 5.4+ compatible
Easy to Use, you can create your Opencart Documentation Easily.

Installation

DocumentPHP requires PHP 5.4 or higher to run. However, code of earlier PHP versions can be analyzed.

All templates provided with DocumentPHP have support for Class diagrams based on the read code base. Rendering is done on Classes.

Install DocumentPHP:

Via Composer

There is a DocumentPHP composer package that you can use to install DocumentPHP.

How to use DocumentPHP ?

To run DocumentPHP after installing via composer and copy the main.php file and make changes accordingly ( file attached in this repo ). Note- Make Sure the main.php file is at the root location.

Contact

Reaching out to us is easy, and can be done with:

Twitter: https://twitter.com/codeeshop1
Twitter 2: https://twitter.com/anantnegik7
Website: https://www.codeeshop.com
GitHub: https://github.com/codeeshop-oc/document-php
E-mail: codeeshop2211@gmail.com

Screenshots

codeeshop-oc/document-php 适用场景与选型建议

codeeshop-oc/document-php 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 5 次下载、GitHub Stars 达 0，最近一次更新时间为 2022 年 02 月 08 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「documentation」「opencart」「DocumentPHP」「Document PHP」「PHP Document」「PHP Documentor」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 codeeshop-oc/document-php 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 codeeshop-oc/document-php 我们能提供哪些服务？

定制开发 / 二次开发

基于 codeeshop-oc/document-php 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 codeeshop-oc/document-php 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

bookdown/themes 11

Bookdown.io With Bootswatch Styles And Prism Syntax Highlighting

code-orange/jot 7

Laravel package that generates RESTful API documentation in Markdown based on PHPDoc.

johnylemon/laravel-apidocs 46

Laravel API documentation generating tool

burdapraha/oc_svg 0

OpenCart 2.x hacked to allow SVG support

butopea/vue-storefront-opencart-vsbridge 17

Vue Storefront Connector Extension for OpenCart

monurakkaya/opencart-eloquent 6

Eloquent support for OpenCart models

codeeshop-oc/document-php

包简介

关键字：