代码风格

Python 的代码风格由 PEP 8 描述。这个文档描述了 Python 编程风格的方方面面。在遵守这个文档的条件下，不同程序员编写的 Python 代码可以保持最大程度的相似风格。这样就易于阅读，易于在程序员之间交流。 一、变量 常量 : 大写加下划线 USER_CONSTANT 对于不会发生改变的全局变量，使用大写加下划线。 私有变量 : 小写和一个前导下划线 _private_value Python 中不存在私有变量一说，若是遇到需要保护的变量，使用小写和一个前导下划线。但这只是程序员之间的一个约定，用于警告说明这是一个私有变量，外部类不要去访问它。但实际上，外部类还是可以访问到这个变量。 内置变量 : 小写，两个前导下划线和两个后置下划线 __class__ 两个前导下划线会导致变量在解释期间被更名。这是为了避免内置变量和其他变量产生冲突。用户定义的变量要严格避免这种风格。以免导致混乱。 二、函数和方法 总体而言应该使用，小写和下划线。但有些比较老的库使用的是混合大小写，即首单词小写，之后每个单词第一个字母大写，其余小写。但现在，小写和下划线已成为规范。 私有方法 ： 小写和一个前导下划线 def _secrete(self): print "don't test me." 这里和私有变量一样，并不是真正的私有访问权限。同时也应该注意一般函数不要使用两个前导下划线

本文档所提供的编码规范，适用于主要的Python发行版中组成标准库的Python代码。请参阅PEP关于Python的C实现的C编码风格指南的描述。 本文档和PEP257（文档字符串规范）改编自Guido的《Python Style Guide》一文，并从《Barry's style guide》添加了部分内容作为补充。 这篇风格指南随着时间的推移而逐渐演变，随着语言本身的变化，一些过去的约定已经过时，并确定了更多新的约定。 许多项目都有自己的编码风格指南。如果有任何冲突，优先使用该项目特定的指南。 愚蠢地坚持一致性是无知的妖怪 Guido的一个重要的见解是，代码阅读的次数比编写的次数多。这里提供的指南旨在提高代码的可读性，并使各种不同的Python代码一致。如PEP20所说，“可读性很重要”。 风格指南是关于一致性的。与本风格指南一致很重要。项目中的一致性更重要。一个模块或函数中的一致性最重要。 最重要的是：知道何时会不一致——有时风格指南就不适用了。怀疑时，作出你最佳的判断。看看其他的例子，并决定什么是最好的。不要犹豫，尽管发问！ 特别地：不要只为遵从这个PEP而打破向后兼容性！ 可以忽略部分风格指南的好理由，不要只为遵从这个PEP而打破向后兼容性！ 忽视既定指南的一些其他的好理由： 当应用指南会降低代码的可读性，即使对于那些习惯遵照这个PEP来阅读代码的人来说。

1 代码风格 稍微关注一下下面这些代码标准风格指导规则将会对你大有益处，我们高度建议你通读词章，即便你此时可能正想跳过它。 1.1 让你的代码保持可读性的重要性 代码在读方面的重要性胜过写。一个代码块几分钟编写，花几个小时调试，然后有可能再也不会有人去碰它。然而当你去阅读那些昨天或者甚至10年以前编写的代码，清晰一致的代码风格就变得非常有用。清晰移动的代码能够让你不用去费劲去理解代码的不一致性，从而节省了自己的脑力，并且使代码易于维护，提高了各种规模项目的整体质量。 下面这些方法让你"多走一公里"使你的代码尽可能清晰易读： 避免缩写的变量名称 写出你的函数的参数名称 对你的类和方法要写注释文档 要对你的代码加注释 把重复的代码重构为可复用的函数和方法 使函数和方法短一点，一个好的经验法则是读函数和方法代码时不需要滚动鼠标(也就是函数或方法的长度不能大于一个屏幕的显示高度) 当你长时间不碰某段代码后，再重新拿起这段代码，你能很容易地找到当初是从哪儿中断编写工作的 缩写变量名是非常令人讨厌的。比如：当你看到一个 balance_sheet decrease 的变量名时，解释它肯定要比解释缩写版的 bsd 或者 bal_s_d 要容易。这种类型的缩写可能会帮你省一点输入时间，但是这种节省是以几小时甚至几天的技术(代码阅读)债为代价，所以这种节省不值当。 1.2 PEP8

块级作用域 字符串 解构赋值 对象 数组 函数 Map结构 Class 模块 ESLint的使用 本章探讨如何将ES6的新语法，运用到编码实践之中，与传统的JavaScript语法结合在一起，写出合理的、易于阅读和维护的代码。 多家公司和组织已经公开了它们的风格规范，具体可参阅 jscs.info ，下面的内容主要参考了 Airbnb 的JavaScript风格规范。 块级作用域 （1）let 取代 var ES6提出了两个新的声明变量的命令： let 和 const 。其中， let 完全可以取代 var ，因为两者语义相同，而且 let 没有副作用。 'use strict'; if (true) { let x = 'hello'; } for (let i = 0; i < 10; i++) { console.log(i); } 上面代码如果用 var 替代 let ，实际上就声明了两个全局变量，这显然不是本意。变量应该只在其声明的代码块内有效， var 命令做不到这一点。 var 命令存在变量提升效用， let 命令没有这个问题。 'use strict'; if(true) { console.log(x); // ReferenceError let x = 'hello'; } 上面代码如果使用 var 替代 let ， console.log 那一行就不会报错

块级作用域 （1）let 取代 var ES6 提出了两个新的声明变量的命令：let和const。其中，let完全可以取代var，因为两者语义相同，而且let没有副作用。 'use strict'; if (true) { let x = 'hello';} for (let i = 0; i < 10; i++) { console.log(i);} 上面代码如果用var替代let，实际上就声明了两个全局变量，这显然不是本意。变量应该只在其声明的代码块内有效，var命令做不到这一点。 var命令存在变量提升效用，let命令没有这个问题。 'use strict'; if (true) { console.log(x); // ReferenceError let x = 'hello';} 上面代码如果使用var替代let，console.log那一行就不会报错，而是会输出undefined，因为变量声明提升到代码块的头部。这违反了变量先声明后使用的原则。 所以，建议不再使用var命令，而是使用let命令取代。 （2）全局常量和线程安全 在let和const之间，建议优先使用const，尤其是在全局环境，不应该设置变量，只应设置常量。 const优于let有几个原因。一个是const可以提醒阅读程序的人，这个变量不应该改变；另一个是const比较符合函数式编程思想，运算不改变值

块级作用域 （1）let 取代 var ES6 提出了两个新的声明变量的命令： let 和 const 。其中， let 完全可以取代 var ，因为两者语义相同，而且 let 没有副作用。 'use strict'; if (true) { let x = 'hello'; } for (let i = 0; i < 10; i++) { console.log(i); } 上面代码如果用 var 替代 let ，实际上就声明了两个全局变量，这显然不是本意。变量应该只在其声明的代码块内有效， var 命令做不到这一点。 var 命令存在变量提升效用， let 命令没有这个问题。 'use strict'; if (true) { console.log(x); // ReferenceError let x = 'hello'; } 上面代码如果使用 var 替代 let ， console.log 那一行就不会报错，而是会输出 undefined ，因为变量声明提升到代码块的头部。这违反了变量先声明后使用的原则。 所以，建议不再使用 var 命令，而是使用 let 命令取代。 （2）全局常量和线程安全 在 let 和 const 之间，建议优先使用 const ，尤其是在全局环境，不应该设置变量，只应设置常量。 const 优于 let 有几个原因。一个是 const

块级作用域 （1）let 取代 var ES6 提出了两个新的声明变量的命令： let 和 const 。其中， let 完全可以取代 var ，因为两者语义相同，而且 let 没有副作用。 'use strict'; if (true) { let x = 'hello'; } for (let i = 0; i < 10; i++) { console.log(i); } 上面代码如果用 var 替代 let ，实际上就声明了两个全局变量，这显然不是本意。变量应该只在其声明的代码块内有效， var 命令做不到这一点。 var 命令存在变量提升效用， let 命令没有这个问题。 'use strict'; if (true) { console.log(x); // ReferenceError let x = 'hello'; } 上面代码如果使用 var 替代 let ， console.log 那一行就不会报错，而是会输出 undefined ，因为变量声明提升到代码块的头部。这违反了变量先声明后使用的原则。 所以，建议不再使用 var 命令，而是使用 let 命令取代。 （2）全局常量和线程安全 在 let 和 const 之间，建议优先使用 const ，尤其是在全局环境，不应该设置变量，只应设置常量。 const 优于 let 有几个原因。一个是 const

1. C# 代码风格要求 1.1注释 类型、属性、事件、方法、方法参数，根据需要添加注释。 如果类型、属性、事件、方法、方法参数的名称已经是自解释了，则不需要加注释；否则必须添加注释。 当添加注释时，添加方式如下图所示： 1.2 类型（类、结构、委托、接口）、字段、属性、方法、事件的命名 优先考虑英文，如果英文没有合适的单词描述，可以使用拼音，使用中文是不符合要求的。 唯一可以使用中文的地方是枚举的枚举项，枚举项实际已经不属于本节标题的范畴了。这里只是放到一起说明，如下图所示： 1.3 不使用缩写 所有类型、方法、参数、变量的命名不得使用缩写，包括大家熟知的缩写，例如msg。 1.4 代码使用半展开 第一步，打开Visual Studio，进入“工具”，“选项...”，如下图所示： 第二步，进入“文本编辑器”，“C#”，“格式设置”，“新行”，取消掉右侧所有复选框中的对号，如下图所示： 第三步，点击“确定”，完成设置。 1.5 使用Tab作为缩进，并设置缩进大小为4 第一步，打开Visual Studio，进入“工具”，“选项...”，如下图所示： 第二步，进入“文本编辑器”，“C#”，“制表符”，如下图所示，设置制表符。 第三步，点击“确定”，完成设置。 1.6 一个.cs源文件至多定义两个类型 如果两个类型的关系是紧密相关的，比如 产品、产品类型，此时Product类

原文 http://www.cnblogs.com/JimmyZhang/archive/2013/06/05/3118936.html PDF版下载： 项目代码风格要求V1.0.pdf 代码风格没有正确与否，重要的是整齐划一，这是我拟的一份《项目代码风格要求》，供大家参考。 1. C# 代码风格要求 1.1注释 类型、属性、事件、方法、方法参数，根据需要添加注释。 如果类型、属性、事件、方法、方法参数的名称已经是自解释了，则不需要加注释；否则必须添加注释。 当添加注释时，添加方式如下图所示： 1.2 类型（类、结构、委托、接口）、字段、属性、方法、事件的命名 优先考虑英文，如果英文没有合适的单词描述，可以使用拼音，不得出现中文。 唯一可以使用中文的地方是枚举的枚举项，枚举项实际已经不属于本节标题的范畴了。这里只是放到一起说明，如下图所示： 1.3 不使用缩写 所有类型、方法、参数、变量的命名不得使用缩写，包括大家熟知的缩写，例如msg。 1.4 代码使用半展开 第一步，打开Visual Studio，进入“工具”，“选项...”，如下图所示： 第二步，进入“文本编辑器”，“C#”，“格式设置”，“新行”，取消掉右侧所有复选框中的对号，如下图所示： 第三步，点击“确定”，完成设置。 1.5 使用Tab作为缩进，并设置缩进大小为4 第一步，打开Visual Studio，进入“工具”

代码风格没有正确与否，重要的是整齐划一，这是我拟的一份《.Net 项目代码风格要求》，供大家参考。 1. C# 代码风格要求 1.1注释 类型、属性、事件、方法、方法参数， 根据需要 添加注释。 如果类型、属性、事件、方法、方法参数的名称已经是自解释了， 不需要 加注释；否则需要添加注释。 当添加注释时，添加方式如下图所示： 1.2 类型（类、结构、委托、接口）、字段、属性、方法、事件的命名 优先考虑英文，如果英文没有合适的单词描述，可以使用拼音，使用中文是不符合要求的。 唯一可以使用中文的地方是枚举的枚举项，枚举项实际已经不属于本节标题的范畴了。这里只是放到一起说明，如下图所示： 1.3 不使用缩写 所有类型、方法、参数、变量的命名不得使用缩写，包括大家熟知的缩写，例如msg。 1.4 代码使用半展开 第一步，打开Visual Studio，进入“工具”，“选项...”，如下图所示： 第二步，进入“文本编辑器”，“C#”，“格式设置”，“新行”，取消掉右侧所有复选框中的对号，如下图所示： 第三步，点击“确定”，完成设置。 1.5 使用Tab作为缩进，并设置缩进大小为4 第一步，打开Visual Studio，进入“工具”，“选项...”，如下图所示： 第二步，进入“文本编辑器”，“C#”，“制表符”，如下图所示，设置制表符。 第三步，点击“确定”，完成设置。 1.6 一个