ob娱乐下载Symfony编码标准以及枝条编码标准
  • 代码示例对于web应用程序上下文应该看起来真实。避免抽象或琐碎的例子(喷火酒吧演示等);
  • 代码应该遵循ob娱乐下载Symfony最佳实践.方法,除非该示例需要自定义包,否则请确保始终使用AppBundleBundle来存储你的代码;
  • 使用Acme当代码需要供应商名称时;
  • 使用example.com作为示例url的域和example.org而且example.net当需要其他域时。所有这些领域都是由IANA保留
  • 为了避免代码块上的水平滚动,我们更倾向于在该行跨越第85个字符时正确地换行;
  • 折叠一行或多行代码时,放置...在注释处折页。这些评论是:/ /……(php),#……(yaml / bash),{#……#}(嫩枝),<!--...-->(xml / html),;...(ini),...(文本);
  • 当你折叠一条线的一部分,例如一个变量值,放...(没有评论)在折叠的地方;
  • 折叠代码描述:(可选)

    • 如果折了几行:可将折后的说明放置...
    • 如果你只折叠一条线的一部分:描述可以放在线的前面;
  • 如果对读者有用,PHP代码示例应该从名称空间声明开始;
  • 引用类时,确保显示使用语句在代码块的顶部。你不需要表现出来所有使用语句在每个例子,只是显示什么是实际使用的代码块;
  • 如果有用,codeblock应以包含代码块中文件文件名的注释开始。不要在这个注释后面放空行,除非下一行也是注释;
  • 你应该放一个在每条线的前面。
  • 配置块.支持的格式(及其顺序)是:

    • 配置(包括服务):YAML, XML, PHP
    • 路由:注释,YAML, XML, PHP
    • 验证:注释,YAML, XML, PHP
    • 教义的映射:注释,YAML, XML, PHP
    • 翻译: xml, yaml, PHP

    谨慎

    在YAML中,你应该在后面加一个空格之前,(如。{_controller:…}),但在Twig中不应该这样做(例如。{'hello': 'value'}).

    美式英语.的美国英语牛津词典用作词汇表引用。

    此外,文档遵循以下规则:欧宝官网下载app

    • 章节标题:使用标题大小写的变体,其中第一个单词总是大写,所有其他单词都是大写,除了封闭类单词(请参阅维基百科关于标题和标题).

      例句:维生素在我的新鲜加利福尼亚葡萄干里

    • 标点符号:避免使用串行(牛津)逗号
    • 代词:避免使用nosism并且总是使用而不是我们.(即避免使用第一人称,使用第二人称);
    • 中性的语言:指一个假想的人,例如“拥有会话cookie的用户”,使用中性代词(they/their/them)。例如,不要:

      • 他或她,使用他们
      • 他或她,利用他们
      • 他或她,用他们的
      • 他的或她的,用他们的
      • 自己或自己,利用自己

    此工作,包括代码示例,是根据创作共用BY-SA 3.0许可证。