Mediawiki.org的PHP编码约定

http://www.mediawiki.org/wiki/Manual:Coding_conventions/PHP

assignment作为expression来用看起来像个错误

// No
if ( $a = foo() ) {
    bar();
}
// Yes
$a = foo();
if ( $a ) {
    bar();
}

为提高代码可读性,Mediawiki大量使用空格

二元运算符

// No
$a=$b+$c;

// Yes
$a = $b + $c;

函数名后面直接跟括号;括号内如有参数,两边都加空格

// Yes
$a = getFoo( $b );
$c = getBar();

控制结构 if while for foreach switch,关键字 catch,后面都有空格

// Yes
if ( isFoo() ) {
    $a = ‘foo‘;
}

// No
if( isFoo() ) {
    $a = ‘foo‘;
}

强制类型转换

// Yes
(int)$foo;

// No
(int) $bar;
( int )$bar;
( int ) $bar;

注释

// Yes: Proper inline comment
//No: Missing space

三元运算符

除非表达式很短,否则用 If。记住一切都为了代码可读性。

"if" is English; ?: is not.

时间: 2024-10-07 21:15:17

Mediawiki.org的PHP编码约定的相关文章

翻译 | QML编码约定

本文翻译自: https://doc.qt.io/qt-5/qml-codingconventions.html 原作者: Qt官网 ??本文档包含我们在文档和示例中应该遵循的QML编码约定,并建议其他人也遵循. 0x01 QML对象声明 ??在整个文档和示例中,QML对象属性始终按以下顺序构造: id property declarations(自定义属性声明) signal declarations(信号声明) JavaScript function(js函数) object propert

C# 编码约定(C# 编程指南)——(待续)

原文链接:C# 编码约定(C# 编程指南) 原文地址:https://www.cnblogs.com/panpanwelcome/p/12430116.html

C# 编码约定(C# 编程指南)

1.              命名约定 ·         在不包括 using 指令的短示例中,使用命名空间限定. 如果你知道命名空间默认导入项目中,则不必完全限定来自该命名空间的名称. 如果对于单行来说过长,则可以在点 (.) 后中断限定名称,如下面的示例所示. var currentPerformanceCounterCategory = new System.Diagnostics. PerformanceCounterCategory(); ·         你不必更改通过使用 V

C# 编码约定

参考自 MSDN     https://msdn.microsoft.com/zh-cn/library/ff926074.aspx , 只摘要个人觉得有用部分 命名约定 在不包括 using 指令的短示例中,使用命名空间限定. 如果你知道命名空间默认导入项目中,则不必完全限定来自该命名空间的名称. 如果对于单行来说过长,则可以在点 (.) 后中断限定名称,如下面的示例所示 var currentPerformanceCounterCategory = new System.Diagnosti

QML 编码约定

由于作者不习惯该编辑器,只是将本文的截图贴了出来,详文见:https://www.yuque.com/docs/share/bfb77071-40e3-456e-8a75-b6996297c54f 原文地址:http://blog.51cto.com/4754569/2324524

C#编码规范-转

转自:原文 http://www.cnblogs.com/wulinfeng/archive/2012/08/31/2664720.html 1 规范目的 ……………………………………………………… 3 2 适用范围 ……………………………………………………… 3 3 代码注释 ……………………………………………………… 3 3.1 代码注释约定............................................ 3 3.2 模块头部注释规范.................

编码规范总结——磨刀不误砍柴工

目录 1.简介... 2 2.适用范围... 2 3.规范目的... 2 4.代码组织与风格... 2 4.1 Tab键... 2 4.2 缩进... 3 4.3空行... 3 4.4函数长度... 3 4.5行宽... 3 4.6{ “,”} 3 5.文件命名... 3 6.命名... 4 6.1基本约定... 4 6.2程序集命名... 4 6.3命名空间命名... 4 6.4类和接口命名... 5 6.5方法命名... 5 6.7变量命名... 5 6.8组件名称缩写列表... 5 6.9

python字符编码惯用法

本文总结在实际应用中遇到的python字符编码问题,制定一套编码相关的约定,避免编码上的错误. 在写猥琐宝典时需要总结soj上做过的题,准备在总结过程中顺便写一个soj上的题解.题解使用python可读,也就是python可以直接eval的格式,以便于处理.写题解老是copy soj上的题目id,title不是太方便,所以就准备自动生成一个空的题解,里面包含了我做过的题.然而直接从soj上只能拿到自己过了的题的id列表,缺乏其它信息.缺乏的信息可以抽象为soj数据库,其中包含了一个以id为主键的

c#编码规范(转载)

原文:http://www.cnblogs.com/wulinfeng/archive/2012/08/31/2664720.html   1  规范目的 --------------------- 3 2  适用范围 --------------------- 3 3  代码注释 --------------------- 3 3.1    代码注释约定............................................ 3 3.2    模块头部注释规范.........