代码风格

项目代码风格要求

主宰稳场 提交于 2020-01-03 01:42:28
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类

C# 代码风格要求

落花浮王杯 提交于 2020-01-03 01:42:14
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类

优秀 Java 程序员写代码的风格

筅森魡賤 提交于 2020-01-03 01:41:52
往 期 精 彩 推 荐 【1】 Java Web技术经验总结 【2】 15个顶级Java多线程面试题及答案,快来看看吧 【3】 面试官最喜欢问的十道java面试题 【4】 从零讲JAVA ,给你一条清晰地学习道路!该学什么就学什么!! 【5】 福利:100G Java全套学习视频免费送了 今天突发奇想,对编码习惯和 编程风格 很感兴趣,于是乎,找了一下关于编程风格(Java篇)的资料,希望对爱好编码或者开始学习编码的同学有帮助! 来自《The Elements of Java Style》-《Java编程风格》一书,值得一读的书籍,会让你在细节上节省很多时间,合作之间更加愉快! 好处不多说了,但是有几个原则如下 1.保持原有风格 2.坚持最小惊奇原则 3.第一次就做对 4.记录所有非规范行为 格式规范 1.缩进嵌套的代码:在每个代码块和嵌套中加入缩进,缩进代码,加强可读性。这些地方包括【类定义,内部类定义,方法定义,静态块,for循环语句,if-else语句,try、catch和finally块,匿名内部类,while语句,do-while语句】 2.断开很长的句子:第一,如果包含了逗号,那么在每一个逗号后面都另起一行,把逗号后面的每一个表达式都和逗号前面的表达式的第一个字母对齐。第二,应该在优先级最低的运算符之前断行。 3.使用空白:关键字和左括号之间,右括号和紧随其后的关键字

JS代码风格指南

故事扮演 提交于 2020-01-03 01:41:42
一.基本格式 缩进 建议每级4个空格,可以给编辑器设置tab = 4个空格,自动转换 分号 不要省略分号,防止ASI(自动插入分号)错误 行宽 每行代码不超过80个字符,过长应该用操作符手动断行 断行 操作符在上一行末尾,且下一行缩进2级,如果是赋值语句,还应该和等号后面部分对齐 空行 函数声明与函数声明、变量声明与函数声明、函数内部的逻辑块之间都应该有空行隔开 作者尼古拉斯还建议在流程控制块顶部留一个空行,但给的例子不是很明确 命名 变量名/函数名:Camel(驼峰)规则,首词首字母小写,后续词首字母大写,其余部分小写 常量名:C语言式,全大写,下划线分词 构造函数:Pascal规则,所有词首字母大写,其余部分小写 字面量 字符串:双引号包裹,断行用[+]操作符, 不要 用\转义字符 数值: 不要 省略小数点前后的部分, 不要 用八进制形式 Null:只把null当作Object的占位符, 不要 用来检测形参,也 不要 用来检测未初始化的变量 Undefined:应该把所有对象都初始化为null,以区分未定义和未初始化 对象字面量/数组字面量: 不要 用构造函数方式声明对象和数组 二.注释 P.S.书中有一句非常经典的解释: Appropriately written comments help tell the story of code, allowing other

.NET 项目代码风格要求

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

项目代码风格要求

妖精的绣舞 提交于 2020-01-03 01:40:20
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类

.Net 项目代码风格要求

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

.Net 项目代码风格规范

人盡茶涼 提交于 2020-01-03 01:39:19
最近没啥时间自己状态也不是很好,公司的事情忙,自己也有一些事情要处理,所以好久没有写博客了。利用公司午休时间写一写,以下是参考了一些资料,整理出来,共勉之。 代码风格没有正确与否,重要的是整齐划一,清晰易读。 1. C# 代码风格要求 1.1注释 类型、属性、事件、方法、方法参数, 根据需要 添加注释。 如果类型、属性、事件、方法、方法参数的名称已经是自解释了, 不需要 加注释;否则需要添加注释。 当添加注释时,添加方式如下图所示: 1.2 类型(类、结构、委托、接口)、字段、属性、方法、事件的命名 优先考虑英文,如果英文没有合适的单词描述,可以使用拼音,使用中文是不符合要求的。 唯一可以使用中文的地方是枚举的枚举项,枚举项实际已经不属于本节标题的范畴了。这里只是放到一起说明,如下图所示: 1.3 不使用缩写 所有类型、方法、参数、变量的命名不得使用缩写,包括大家熟知的缩写,例如msg。 1.4 代码使用半展开 第一步,打开Visual Studio,进入“工具”,“选项...”,如下图所示: 第二步,进入“文本编辑器”,“C#”,“格式设置”,“新行”,取消掉右侧所有复选框中的对号,如下图所示: 第三步,点击“确定”,完成设置。 1.5 使用Tab作为缩进,并设置缩进大小为4 第一步,打开Visual Studio,进入“工具”,“选项...”,如下图所示: 第二步,进入

Javascript 编程风格

有些话、适合烂在心里 提交于 2020-01-03 01:33:09
  Douglas Crockford 是 Javascript 权威,Json 格式就是他的发明。   去年 11 月他有一个演讲( Youtube ),谈到了好的 Javascript 编程风格是什么。   我非常推荐这个演讲,它不仅有助于学习 Javascript,而且能让你心情舒畅,因为 Crockford 讲得很幽默,时不时让听众会心一笑。   下面,我根据这个演讲和 Crockford 编写的 代码规范 ,总结一下"Javascript 编程风格"。   所谓"编程风格"(programming style),指的是编写代码的样式规则。不同的程序员,往往有不同的编程风格。   有人说,编译器的规范叫做"语法规则"(grammar),这是程序员必须遵守的;而编译器忽略的部分,就叫"编程风格"(programming style),这是程序员可以自由选择的。这种说法不完全正确,程序员固然可以自由选择编程风格,但是好的编程风格有助于写出质量更高、错误更少、更易于维护的程序。   所以,有一点应该明确,"编程风格"的选择不应该基于个人爱好、熟悉程度、打字工作量等因素,而要考虑如何尽量使代码清晰易读、减少出错。你选择的,不是你喜欢的风格,而是一种能够清晰表达你的意图的风格。这一点,对于 Javascript 这种语法自由度很高、设计不完全成熟的语言尤其重要。    一

学习js的五个不良编码习惯

南楼画角 提交于 2020-01-01 17:25:39
本文根据外网文章译制而来   原文:https://dmitripavlutin.com/unlearn-javascript-bad-coding-habits/   译者:前端小智   为了保证的可读性,本文采用意译而非直译。   在阅读JavaScript代码时,你是否有过这种感觉   你几乎不明白代码的作用?   代码使用了很多 JavaScript 技巧?   命名和编码风格太过随意?   这些都是不良编码习惯的征兆。   在这篇文章中,我描述了JavaScript中常见的5种不良编码习惯。重要的是,本文会给出一些可行的建议,如何的摆脱摆脱这些习惯。   1.不要使用隐式类型转换   JavaScript是一种松散类型的语言。如果使用得当,这是一个好处,因为它给你带来了灵活性。   大多数运算符 +-*/==(不包括 ===)在处理不同类型的操作数时会进行隐式转换。   语句 if(condition){...}, while(condition){...}隐式地将条件转换为布尔值。   下面的示例依赖于类型的隐式转换,这种有时候会让人感到很困惑:   console.log("2" + "1"); // => "21"   console.log("2" - "1"); // => 1   console.log('' == 0); // => true