欧宝官网下载app文档格式
编辑本页警告:您正在浏览的文档欧宝官网下载appob娱乐下载Symfony 3.4,现已不再维护。
读本页的更新版本用于Syob娱乐下载mfony 6.2(当前稳定版本)。
欧宝官网下载app文档格式
Symfob娱乐下载ony文档使用的欧宝官网下载appreStructuredText作为其标记语言和斯芬克斯用于生成终端用户可阅读的格式的文档,例欧宝官网下载app如HTML和PDF。
reStructuredText
reStructuredText是一种与Markdown类似的纯文本标记语法,但语法要严格得多。如果您是reStructuredText的新手,请花一些时间通过阅读现有的文本来熟悉这种格式ob娱乐下载Symfony的欧宝官网下载app文档源代码。
如果您想了解更多关于此格式的信息,请查看reStructuredText底漆教程和reStructuredText参考.
谨慎
如果你熟悉Markdown,请小心,因为有时情况非常相似但又不同:
- Lists从一行的开头开始(不允许缩进);
- 内联代码块使用双引号(
这样的' ' ' '
).
斯芬克斯
斯芬克斯是一个构建系统,它提供了从reStructuredText文档创建文档的工具。欧宝官网下载app因此,它向标准reStructuredText标记添加了新的指令和解释文本角色。阅读更多有关Sphinx标记构造.
语法高亮显示
PHP是应用于所有代码块的默认语法高亮显示。你可以用代码块
指令:
1 2 3
..代码块:yaml{foo: bar, bar: {foo: bar, bar: baz}}
请注意
除了所有主要的编程语言,语法高亮显示器还支持各种标记和配置语言。看看列表支持的语言在语法高亮显示网站上。
配置块
每当包含配置示例时,请使用配置块
指令以所有支持的配置格式显示配置(PHP
,YAML
而且XML
).例子:
12 3 4 5 6 7 8 9 10 11 12 13
..配置块::..代码块:yaml# YAML中的配置..xml代码:<!——XML配置——>..php代码:// PHP中的配置
之前的reStructuredText代码片段呈现如下:
- YAML
- XML
- PHP
1
# YAML中的配置
当前支持的格式列表如下:
标记格式 | 使用它来显示 |
---|---|
超文本标记语言 |
超文本标记语言 |
xml |
XML |
php |
PHP |
yaml |
YAML |
嫩枝 |
纯Twig标记 |
html +树枝 |
混合了HTML的树枝标记 |
html + php |
混合HTML的PHP代码 |
ini |
INI |
php-annotations |
PHP的注释 |
添加链接
最常见的链接类型是内部链接到使用以下语法的其欧宝官网下载app他文档页:
1
医生:“绝对路径/ /页面”
页名不应包括文件扩展名(首要
).例如:
1 2 3 4 5
医生:“/控制器”医生:' /组件/ event_dispatch '医生:“/配置/环境”
链接页面的标题将自动用作链接的文本。如果你想修改这个标题,请使用下面的语法:
1
医生:' Spooling Email Email /spool> '
请注意
虽然它们在技术上是正确的,但避免使用如下这样的相对内部链接,因为它们会破坏生成的PDF文档中的引用:欧宝官网下载app
1 2 3 4 5
医生:“控制器”医生:“event_dispatch”医生:“环境”
到API的链接遵循不同的语法,其中必须指定链接资源的类型(类
或方法
):
1 2 3
类:“ob娱乐下载Symfony组件\ \ \ \ \ \匹配器\ \ ApacheUrlMatcher路由的方法:的ob娱乐下载Symfony \ \ HttpKernel \ \ \ \组件包\ \包::构建的
到PHP文档的链接欧宝官网下载app遵循非常相似的语法:
1 2 3 4 5
: phpclass:“SimpleXMLElement”: phpmethod:DateTime:: createFromFormat”: phpfunction:“iterator_to_array”
新特性,行为变化或弃用
如果你正在记录Symfony中一个全新的特性、变更或弃用,你应该在描述变更之前加上相应的指令和简短的描述:ob娱乐下载
对于新特性或行为更改,请使用..versionadded:: 3. x
指令:
1 2 3
..versionadded:: 3.4特别的“”!模板前缀在Symfony 3.4中引入。ob娱乐下载
如果你正在记录一个行为改变,它可能会对你有帮助短暂的描述行为是如何改变的:
1 2 3 4
..versionadded:: 3.4引入了不使用外部包的注释路由支持在Syob娱乐下载mfony 3.4。在此之前,您需要安装sensioframeworkextrabundance。
用于弃用..弃用::3. x
指令:
1 2 3 4
..弃用::3.3不鼓励使用这种技术,addClassesToCompile()方法是不鼓励使用的在Symfony 3.3中已ob娱乐下载弃用,因为现代PHP版本不再需要它。
每当Symfony的一个新的主要版本发布时(例如3.0、4.0等ob娱乐下载),文档的一个新分支就会从欧宝官网下载app主
分支。此时此刻,所有的versionadded
而且弃用
带有较低主版本的Sob娱乐下载ymfony版本的标签将被删除。例如,如果Symfony 4.0ob娱乐下载今天发布,3.0到3.4versionadded
而且弃用
标签将从新的4.0
分支。