包简介

This package can convert PHPDoc comments from classes into Markdown. It can parse a class file with a given file name and extracts the documentation of its functions and variables that it may contain in PHPDoc format. The package can convert the extracted documentation into a file in Markdown form

README 文档

README

Version: 0.1.11 beta

Github: https://github.com/marcocesarato/PHP-Class-Markdown-Docs

Author: Marco Cesarato

Description

This package can convert PHPDoc comments from classes into Markdown.

It can parse a class file with a given file name and extracts the documentation of its functions and variables that it may contain in PHPDoc format.

The package can convert the extracted documentation into a file in Markdown format.

Install

Composer

Install composer
Type composer require marcocesarato/markdown
Enjoy

Methods

Method	Description	Type	Parameters	Return
getMarkdown	Get markdown class documentation	public static	$file	string
printMarkdown	Print Markdown class documentation	public static	$file
getArray	Get php array class documentation	public static	$file	array

Example

Usage

Markdown::printMarkdown('Sample.php');

Output Text

## CoreClass
| Method        | Description                                        | Type   | Parameters                                         | Return         |
| ------------- | -------------------------------------------------- | ------ | -------------------------------------------------- | -------------- |
| __construct   | Constructor                                        | public |                                                    |                |
| __init        | Initialize                                         |        |                                                    | bool           |
| CoreClass     | Constructor                                        |        |                                                    |                |
| getInstance   | Get singleton instance                             |        |                                                    | CoreClass      |
| apply_filters | Apply module hook filters                          |        | $name<br>$data                                     | mixed          |
| do_action     | Do module hook actions                             |        | $name                                              | bool           |
| add_action    | Add module hook action                             |        | $name<br>$action                                   | bool           |
| add_filter    | Add module hook filter                             |        | $name<br>$filter                                   | bool           |
| add_request   | Add Ajax request                                   |        | $name<br>$request<br>bool $public                  | bool           |
| exists        | Check if element already exists if exists it will be updated on Save else it will be inserted |        | null $what<br>bool $undelete                       | bool           |
| prepare       | Prepare retrieve conditions                        |        | null $what<br>null $operators                      | array          |
| retrieve      | Retrieve element                                   |        | null $what<br>bool $encode<br>null $onlyFields<br>null $orderBy<br>bool $returnAsArray<br>null $operators<br>bool $dump | array<br>mixed |
| fetch         |                                                    |        | $what<br>null $operators                           | array          |

Markdown Result

CoreClass

Method	Description	Type	Parameters	Return
__construct	Constructor	public
__init	Initialize			bool
CoreClass	Constructor
getInstance	Get singleton instance			CoreClass
apply_filters	Apply module hook filters		$name $data	mixed
do_action	Do module hook actions		$name	bool
add_action	Add module hook action		$name $action	bool
add_filter	Add module hook filter		$name $filter	bool
add_request	Add Ajax request		$name $request bool $public	bool
exists	Check if element already exists if exists it will be updated on Save else it will be inserted		null $what bool $undelete	bool
prepare	Prepare retrieve conditions		null $what null $operators	array
retrieve	Retrieve element		null $what bool $encode null $onlyFields null $orderBy bool $returnAsArray null $operators bool $dump	array mixed
fetch			$what null $operators	array

marcocesarato/markdown 适用场景与选型建议

marcocesarato/markdown 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 531 次下载、GitHub Stars 达 15，最近一次更新时间为 2019 年 05 月 31 日，在 PHP 生态内属于活跃度较高的组件。

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

围绕 marcocesarato/markdown 我们能提供哪些服务？

定制开发 / 二次开发

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

BUG 修复 & 性能优化

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

项目外包 & 长期维护

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

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

marcocesarato/markdown

包简介