Coding style 防御性编码实践_Coding Style

Coding style 防御性编码实践

coding-style

Coding style 防御性编码实践,coding-style,Coding Style,自从我第一次写 if ($a = 5) { # do something with $a, e.g. print "$a"; } 并经历了正常的令人困惑的会议为什么结果总是正确的为什么一美元总是5美元直到我意识到，我将5分配给$a，而不是进行比较所以我决定把上面的条件写成 if (5 == $a) 换言之：如果忘记添加第二个“=”号，请始终将常量值放在比较运算符的左侧，从而导致编译错误。我倾向于称之为防御性编码，并倾向于认为它是防御性编程的近亲，不是在算法规模

自从我第一次写

if ($a = 5) {
   #  do something with $a, e.g.
   print "$a";
}

并经历了正常的令人困惑的会议

为什么结果总是正确的
为什么一美元总是5美元

直到我意识到，我将5分配给$a，而不是进行比较

所以我决定把上面的条件写成

 if (5 == $a)

换言之：

如果忘记添加第二个“=”号，请始终将常量值放在比较运算符的左侧，从而导致编译错误。

我倾向于称之为防御性编码，并倾向于认为它是防御性编程的近亲，不是在算法规模上，而是逐字逐句

您开发了哪些防御性编码实践

一周后：

对所有回答的人或将来可能添加另一个答案的人说一声“谢谢”

不幸的是（或者更幸运的是！）没有单一的正确答案。因此，我的问题非常广泛，更多地询问意见或经验教训，而不是事实

这是一个简单而明显的例子，但我从来没有在我的代码中重复同一个字符串常量两次，因为我知道如果我这样做，我将拼写其中一个错误：）请使用常量，各位

我不再使用你可以使用的语言了

if a = 5: print a

这帮我省去了很多麻烦

更严肃地说。。。现在，我总是在编写

if

s和

for

循环后立即编写花括号，然后再填充它们。这样可以确保我的括号始终对齐。

始终在if/for/while之后放上大括号。。。即使后面只有一句话。顺便说一句，Crockford也认为这样更好：

返回可变对象的副本，即数组的副本，而不是可变对象本身。

始终使用大括号：

if(boolean)
    oneliner();
nextLineOfCode();

不同于：

if(boolean)
{
    oneliner();
}
nextLineOfCode();

如果oneliner（）是一个#定义的函数，但没有定义它，那么您的下一行代码就会突然受制于If（）。同样的事情也适用于带有大括号的for循环等，那么下一段代码决不会无意中成为if/for等的条件。

我采用的前三种防御性编码实践是

单元测试

对于代码质量来说，最好的防御措施莫过于一个好的单元测试来支持您。

避免不必要的测试。范例

if（bool==true）

指针检查（指针）

编辑： if（指针）不可读，所以现在我更喜欢if（NULL！=指针）

两件事：

是的，单线区段。使用大括号。。。见鬼，大多数好的IDE都会为你制作它们
在编写代码后对其进行注释，如果您提前完成了，则重新阅读注释。确保您的代码仍然符合注释所述
单元测试是重读代码的一个很好的退路
总是记录一个异常。。。或者，至少在调试过程中，不要在没有说明的情况下捕获异常

始终初始化变量
尽可能使用
```
const
```
（不使用
```
mutable
```
）
避免动态分配内存或其他资源
始终使用大括号
在编码实现之前，为任何类编写用例和测试代码
打开尽可能多的有用警告（
```
-Wall-Wextra-ansi-pedantic-Werror
```
）
使用解决问题的最简单工具（在我当前的环境中，就是
```
bash
```
->
```
grep
```
->awk->Python->C++）

#pragma warning(3,4706)

if ("blah".equals(value)){}

if (value.equals("blah")){}

function one(){
    return {
        result:"result"
    };
}

function two(){
    return 
    {
        result:"result"
    };
}

未定义的

return

积极思考，尽早返回，避免深度嵌套。而不是
if（值！=null）{ …做一些有价值的事情。。。 } 返回
写
如果（值==null）{ 返回 } ... 做一些有价值的事情
避免使用“字符串常量”（即同一文本在多个引号中）。始终定义一个实常量（带有名称和可选注释，说明其含义）并使用它