README

关于
安装
使用（库）
使用（二进制文件）
类: diversen\markdownDocs
- 属性
- 方法
  - public classToMD
  - public getOutput

关于

简单易用的PHP类文档系统，可以生成Markdown输出。它与github.com等网站配合使用非常方便，您可以在README.md文件中包含类的文档，就像您现在看到的一样。最适合小型代码库，可能包含几个类。

安装

composer require diversen/php-markdown-docs

使用（库）

    use diversen\markdownDocs;

    $md = new markdownDocs();
    // Class to be generate documentaiton for
    $class = 'diversen\markdownDocs';
    $md->classToMD($class);
     
    echo $md->getOutput();

使用（二进制文件）

当库安装完成后，您可以访问markdown-docs二进制文件，并可以使用类似以下的方式使用：

./vendor/bin/markdown-docs --public 'diversen\markdownDocs'

这将仅将Markdown文档输出到stdout，因此您需要将其重定向到文件。

如果您希望在文档中包含private, public, 和 protected方法，可以移除--public标志。此标志表示仅包含输出中的public属性和方法。

您可以在使用composer autoload.php自动加载的任何类上运行它。

类: diversen\markdownDocs

一个简单的类，可以从php源文件（使用phpdocs格式）生成markdown。实际工作是通过Nette\Reflection完成的。查看：https://github.com/nette/reflection

属性

方法

public classToMD

Generates markdown output for a specified class

@param string $class e.g. `PDO` or a user class like `diversen\markdownDocs`

@return void the method adds to $output

public getOutput

Returns the markdown phpdocs

@return string $output the final markdown output

diversen / php-markdown-docs

维护者

详细信息