通过 
搜索
搜索maslosoft / zamm
Zamm 是一个文档工具
2.0.3
2023-06-29 14:43 UTC
Requires
- maslosoft/staple: *
- symfony/console: ^5|^6|^7
Requires (Dev)
- roave/security-advisories: dev-latest
README
Maslosoft Zamm
快速安装
composer require maslosoft/zamm
文档
工作示例
确保示例或代码片段真正可用非常重要。在用 Markdown、TeX 或其他文档工具编写文档时，很容易遗漏一些重要的代码片段，并创建出损坏的示例。当使用像 NetBeans 或 Eclipse 这样的高级 IDE 时，可以避免许多早期的代码问题。这也有助于重构——这也需要应用到文档中。同时，对类有良好的 PHP 文档也非常重要。
基本上，这意味着需要保持以下三个方面的一致性，而创建顺序大致如下
PHP 代码 PHP 文档块 文档
最好尽可能多地从代码或文档块中复用在文档中。
用 PHP 编写的文档
为了使文档与 Zamm 更一致，文档可以包含 PHP 代码片段、源代码片段或从源代码中提取的 phpdoc 注释。然后，这些片段可以根据上下文进行渲染，通常使用 pre 标签或 Markdown 栅栏包裹。
Zamm 可以 捕获行内 PHP 代码片段，允许在获取源代码的同时就地执行 PHP 代码。这对于 用户界面演示 非常有用。