README

目录

1. Markdown
   1. SamiTwigExtension 一个扩展，可以将代码构建成单个 ReadMe markdown 文件。

文档

Markdown

类

SamiTwigExtension Markdown

• 类扩展自 Twig_Extension

一个扩展，可以将代码构建成单个 ReadMe markdown 文件。

目前，大部分工作都是在“幕后”完成的，模板非常简单。这意味着您无法进行太多更改来改变布局等，除非编辑实际的代码/类，但您可以通过调用“render_classes”、“render_class”等方法来更改模板结构，但请注意，这些方法不会删除空白字符，并会处理模板可能遇到的任何格式问题。

由于缺乏单一文件文档，对于项目来说，并且由于 markdown 语言对格式要求非常严格（缩进、符号等），使用 twig 模板很麻烦，最终导致多个“twig 文件”难以阅读（没有缩进等）。

获取 Sami 并分支此仓库

git clone giaever@git.giaever.org:joachimmg/sami-markdown.git

将 SamiTwigExtension.php 包含到 Sami 配置文件中，并将其添加到 twig 中。请参阅 example.conf.php 或

• 设置模板： "template" => "markdown"
• 添加扩展

$sami["twig"]->addExtension(new Markdown\SamiTwigExtension());

方法

方法详情

__construct Markdown\SamiTwigExtension

public function __construct(bool $pretty_print = false);

参数

getFunctions Markdown\SamiTwigExtension

public function getFunctions();

为模板引擎设置可用的函数。

short_description Markdown\SamiTwigExtension

public static function short_description(Reflection $refl, bool $oneliner = true, int $max = -1);

返回反射的简短描述。

参数

返回: string v null

long_description Markdown\SamiTwigExtension

public static function long_description(Reflection $refl, bool $oneliner = false);

返回反射的简短和长描述。

参数

返回: string v null

deprecated Markdown\SamiTwigExtension

public static function deprecated(Reflection $refl, bool $notice = true);

如果类、方法等已弃用，则返回一个弃用标签。

如果 $notice 为 false，则包括文档中提供的弃用说明 - 如果有的话。

参数

返回: string v null

todo Markdown\SamiTwigExtension

public static function todo(Reflection $refl);

返回 Reflection 的 todo 标签。

参数

返回: array v null

see Markdown\SamiTwigExtension

public static function see(Reflection $refl);

返回 Reflection 的 see 标签。

参数

返回: array v null

href Markdown\SamiTwigExtension

public static function href(string $ltxt, string $lurl, bool $namespace = false, string $desc = null);

返回 markdown 链接。

要匹配 markdown 模板类，链接到 #classname-namespace，方法链接到 #method-namespace\classname，命名空间链接到 #namespace，链接时将 $namespace 设置为 true。

参数

返回: string

toc Markdown\SamiTwigExtension

public static function toc(array $tree, int $depth);

目录表

从整个项目树生成目录表。

参数

返回: string

param_hint Markdown\SamiTwigExtension

public static function param_hint(ParameterReflection $param, bool $link = false);

获取参数提示。

这可能是 string、bool 等，如果参数可以是 mixed，则可能是多个。如果函数签名中没有声明，则提示将自动为 mixed。

如果提示是该包的一部分（根命名空间），并且将 link 设置为 true，则将返回对类型的内部链接，但如果将 link 设置为 true 且类型是

• ...,
• iterable 或
• 其他内容

它将返回对类型的链接或添加 Google 搜索查询链接。

参数

返回: string

默认参数 Markdown\SamiTwigExtension

public static function param_default(ParameterReflection $param);

获取参数的默认值。

参数

返回: string v null

方法提示 Markdown\SamiTwigExtension

public static function method_hint(MethodReflection $method, bool $link = false);

获取方法提示。

这些提示通常是方法的返回值，例如 string，bool 等。

方法的工作方式与 param_hint 类似。

参数

返回: string

方法访问 Markdown\SamiTwigExtension

public static function method_access(MethodReflection $method);

获取方法访问权限。

返回方法是否为抽象的、最终的、受保护的等。方法访问可以混合使用，此方法将包含所有。

参数

返回: string

方法签名 Markdown\SamiTwigExtension

public static function method_signature(MethodReflection $method, bool $incname = true);

获取方法的签名。

返回函数名、参数和访问权限。如果将 $incname 设置为 true，还包括默认参数值。

格式将是

access function name(paramterers [= "value"]);

参数

返回: string

方法源代码链接 Markdown\SamiTwigExtension

public static function method_source_url(MethodReflection $method);

返回方法在源代码中的链接。

参数

返回: string

render_methods Markdown\SamiTwigExtension

public static function render_methods(array $methods);

渲染方法。

返回方法数组中每个方法的摘要和详细描述。

参数

返回: string v null

render_class Markdown\SamiTwigExtension

public static function render_class(ClassReflection $class);

渲染类

返回有关类及其方法的信息。

参数

返回: string

render_classes Markdown\SamiTwigExtension

public static function render_classes(array $classes);

渲染一个或多个类。

通常应用于单个命名空间。

确定哪种类型的类（例如 trait，interface 等）并在结构/顺序中返回它们

命名空间

• 普通类，
• 特质，
• 接口，
• 异常。

参数

返回: string v null

render_namespace Markdown\SamiTwigExtension

public static function render_namespace(string $namespace, array $namespaces, array $classes);

渲染命名空间。

返回有关整个命名空间的信息，只要将子命名空间和类传递给方法即可。

参数

返回: string

render Markdown\SamiTwigExtension

public static function render(array $namespaces, array $classes);

渲染整个 ReadMe。

将绑定类及其子命名空间并按命名空间渲染。

参数

返回: string

• 使用 Sami 和 Sami/Twig Markdown 扩展 生成