欧宝官网下载app文档格式
编辑该页面警告:你浏览的文档欧宝官网下载appob娱乐下载Symfony 5.0,不再维护。
读这个页面的更新版本Symfob娱乐下载ony 6.3(当前的稳定版本)。
欧宝官网下载app文档格式
Symfob娱乐下载ony的文档使用欧宝官网下载appreStructuredText作为标记语言斯芬克斯生成的文档的格式读取到最终用户,如HT欧宝官网下载appML和PDF。
reStructuredText
恰好是一个纯文本标记语法类似于减价,但是严格的语法。如果你恰好,花些时间来熟悉这个格式通过阅读现有的ob娱乐下载Symfony的欧宝官网下载app文档源代码。
如果你想了解更多关于这种格式,请查看reStructuredText底漆教程和reStructuredText参考。
谨慎
如果您熟悉减价,小心有时非常相似但不同的东西:
- 列出从一行的开始(不允许缩进);
- 内联代码块使用double-ticks (
这样的' ' ' '
)。
斯芬克斯
斯芬克斯是一种构建系统,从reStructuredText文档提供了工具来创建文档。欧宝官网下载app因此,它增加了新的指令和解释文本角色标准reStructuredText标记。阅读更多关于斯芬克斯标记构造。
语法高亮显示
PHP是默认语法高亮显示应用到所有的代码块。你可以改变它的代码块
指令:
1 2 3
. .代码块:yaml{foo:酒吧,酒吧:{foo:酒吧,酒吧:baz}}
请注意
除了所有主要的编程语言,语法高亮显示支持各种各样的标记和配置语言。查看列表支持的语言语法高亮显示的网站。
配置块
每当你包括配置示例中,使用配置块
指令显示配置在所有支持的配置格式(PHP
,YAML
和XML
)。例子:
1 2 3 4 5 6 7 8 9 10 11 12 13
. .配置块::. .代码块:yaml#配置在YAML. .xml代码:< !——在XML配置- - >. .php代码:/ /配置PHP
前面reStructuredText片段显示为:
1
#配置在YAML
1
< !——在XML配置- - >
1
/ /配置PHP
当前支持的格式列表如下:
标记格式 | 用它来显示 |
---|---|
html |
HTML |
xml |
XML |
php |
PHP |
yaml |
YAML |
嫩枝 |
纯粹的树枝标记 |
html +树枝 |
树枝混合了HTML标记 |
html + php |
PHP代码和HTML混合 |
ini |
INI |
php-annotations |
PHP的注释 |
添加链接
最常见的类型的链接内部链接其他文档页面,使用欧宝官网下载app下面的语法:
1
医生:“绝对路径/ /页面”
页面名称不应该包括文件扩展名(首要
)。例如:
1 2 3 4 5
医生:“/控制器”医生:' /组件/ event_dispatch '医生:“/配置/环境”
链接页面的标题将自动作为链接的文本。如果您想修改标题,使用这个替代语法:
1
医生:“教义协会< /理论/协会>”
请注意
尽管他们在技术上是正确的,避免使用相对内部链接如以下,因为他们打破了引用生成的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:: 5. x
指令:
1 2 3
. .versionadded:: 5.2………是在Symfony 5.2中引入的。ob娱乐下载
如果你记录行为改变,它可能是有用的短暂的描述的行为改变了:
1 2 3 4
. .versionadded:: 5.2………是在Symfony 5.2中引入的。ob娱乐下载在这之前,……………………。
弃用使用. .弃用::5. x
指令:
1 2 3
. .弃用::5.2………在Symfony 5.2中被弃用。ob娱乐下载
每当一个新Symfony的主要版本发布(如6.0、7.0等),一ob娱乐下载个新的分支的创建文档欧宝官网下载app主
分支。在这一点上,所有的versionadded
和弃用
标签的Symfonob娱乐下载y版本较低的主要版本将被删除。例如,如果Symfony 6.0ob娱乐下载是今天发布,5.0到5.4versionadded
和弃用
从新的标签将被删除6.0
分支。