如何让编码更加的标准

1.概述

  在写这片博文时,我也是思绪良久,参考了不同语言的编码风格,最后总结出如何让自己的编码更加标准。

2.基础

  以Java的基础为例子来说明:

  • 文件编码格式为UTF-8
  • package需要置于最顶层
  • import包时,使用eclipse的快捷键(command+1)倒入对应的包(这样我们可以不用考虑包的顺序如何排列)
  • 格式化代码采用eclipse的快捷键(command+shift+f)进行格式代码
  • if,else,for,while等语句,必须加上大括号({}),即使语句为空
  • 代码块缩进,采用2个空格
  • 列限制在120个字符,对于超过120个字符的语句或方法建议重构(这样方便阅读,及代码的美观性)
  • tab键默认采用4个字符的长度

3.规范

  在编写代码时,需要注意一下规范:

  在进行逻辑判断时,else语句必须添加,即使,else语句为空,也得添加在if语句后面

 1 public void getAppDetail(App app){
 2
 3     if(app != null){
 4        // 业务逻辑处理
 5     }else{
 6        // 若没有业务逻辑处理,此处也需要加上,可以打印一条log
 7        log.info("App object is null");
 8     }
 9
10 }

  在书写switch语句时,default需要加上,即使它什么代码也不包含

switch(index){
    case 1:
              //  调用逻辑方法
              break;
    case 2:
              //  调用逻辑方法
              break;
    default:
              //  不涉及任务业务,打印日志信息
              log.info("Index is undefined");
              break;
}

  在进行代码块注释的时候,需要注意,但行可以使用 /* ... */,也可以使用 // ... 。对于多行的 /* ... */注释,必须从 * 开始,并且与前一行的 * 对其。以下为范例:

// 当行注释

/* 当行注释 */

/*
 * 多行
 * 注释
 */

  关于命名约定可以参考,如何让命名变得优雅

  在书写try ... catch语句时,建议catch语句中只设计输出日志信息(或者将异常抛出),不涵盖业务逻辑处理。

try{
    // 业务逻辑处理
    ......
}catch(Exception e){
    // 打印对应的异常信息
    log.error(String.format("Error message is %s",e));
}

try{
    // 业务逻辑处理
    ......
}catch(Exception e){
    // 抛出对应的异常信息
    throw new Exception();
}

4.总结

  冰冻三尺非一日之寒,要养成好的风格也非一朝一夕能完成,这需要我们自己在平时编码的时候去注意这些细节,并且严格的要求自己。亡羊补牢,为时不晚,特写此博文,与君共勉。

时间: 2024-10-16 06:16:07

如何让编码更加的标准的相关文章

为什么写注释必须成为编码的硬性标准(双语原创)

为什么写注释必须成为编码的硬性标准(双语原创) Why Writing Annotation Must Become Peremptory Rule? 程序猿最烦的事:别人的代码不写注释:自己写注释. Parodox: It is most hated for programmers that others'code have not annotations, and oneself must write annotations. 1.注释最主要是给别人看的,供自己回顾是锦上添花 理解一个人的思

字符编码的非标准理解

零.万物归宗 ASCII码 (American Standard Code for Information Interchange,美国标准信息交换代码),最原始最直观的表示方式,一个字节表示一个字符,一个字节=8位,那么一个字节就有256(2的8次方)种状态.这又分为标准ASCII和扩展ASCII,其中: 标准ASCII (十进制0~127) 使用一个字节中除去最高位以外的7 位来表示所有的大写和小写字母,数字0 到9.标点符号,以及在美式英语中使用的特殊控制字符. Tips:标准ASCII中

(转)视频编码标准汇总及比较

MPEG-1 类型:Audio&Video 制定者:MPEG(Moving Picture Expert Group) 所需频宽:2Mbps 特性:对动作不激烈的视频信号可获得较好的图像质量,但当动作激烈时,图像就会产生马赛克现象.它没有定义用于额外数据流进行编对码的格式,因此这种技术不能广泛推广.它主要用于家用VCD,它需要的存储空间比较大. 优点:对动作不激烈的视频信号可获得较好的图像质量. 缺点:当动作激烈时,图像就会产生马赛克现象.它没有定义用于额外数据流进行编对码的格式,因此这种技术不

url、base64 编码规则

UrlEncode 相关: URI所允许的字符分作保留与未保留. 保留字符是那些具有特殊含义的字符. 例如, 斜线字符用于URL (或者更一般的, URI)不同部分的分界符. 未保留字符没有这些特殊含义. 百分号编码把保留字符表示为特殊字符序列. 上述情形随URI与URI的不同版本规格会有轻微的变化. RFC 3986 section 2.2 保留字符 (2005年1月) ! * ' ( ) ; : @ & = + $ , / ? # [ ] RFC 3986 section 2.3 未保留字符

字符集编码

http://blog.chinaunix.net/uid-20761674-id-3486843.html http://www.searchtb.com/2012/04/chinese_encode.html 编码问题的例子 在windows自带的notepad(记事本)程序中输入“联通”两个字,保存后再次打开,会发现“联通”不见了,代之以“???”的乱码.这是windows平台上典型的中文编码问题.即文件保存的时候是按照ANSI编码(其实就是GB2312,后面会详细介绍)保存,打开的时候程

检测PHP程序员是否合格的四十条标准

四十条标准检测你是否是一个合格的PHP程序员,网上看到的,也不知道是谁出的标准,不官方,也不权威,但很给力,对在做php开发的同志们还是比较有参考性的.以下标准超过三条就不合格了.超过五条就得好好反省下自己的不足了.不可当真,仅供参考反省之用.1. 不会利用如phpDoc这样的工具来恰当地注释你的代码2. 对优秀的集成开发环境如 EclipsePHP EPP 或 Zend Studio PDT视而不见3. 从未用过任何形式的版本控制系统,如Subclipse4. 不采用某种编码与命名标准,以及通

字符编码概述

1 字符编码是什么? 我们知道,计算机数据只能是二进制的,数值类型的数据转换成二进制很简单,我们已经了解了,但字符类型如何转换成二进制呢?这就需要使用字符编码! 在编码表中,每个字符都有对应的编码,编码是整数,最终在计算机中存储的是字符的编码,而不是字符本身(因为计算机数据都是二进制数值,所以字符本身是无法存储的). 当我们存储字符’A’时,其实是通过编码表找到’A’字符对应的编码,然后把编码存储在计算机中.即存储的是65. 当我们读取字符时,其实读取的也是字符的编码,然后使用编码再去编码表中查

射频识别技术漫谈(2)——国际标准

如果你只是智能卡的用户,通常可以不必关注国际标准,但作为智能卡的专业开发人员,则至少也要对相关标准有所了解.国际标准一般都是西方人制定的,原版都是英文的,而所谓中文版往往是对原版的直译,许多情况下并未准确说出实际的意思,所以如果想看这些标准,还是看原版好.以下仅简单介绍比较重要的关于智能卡的国际标准.以后的叙述我可能很少提及这些标准,不读这些标准也不影响朋友们继续往下读,但是正所谓没有规矩,不成方圆,在这里只是告诉大家,之后的叙述都是基于这些国际标准的. 一.ISO 7810:规定了识别卡的物理

数字电视标准综述(2)

五.DVB与 ATSC的比較 欧洲"DVB标准"和美国"ATSC数字电视标准"的主要差别例如以下: (1)方形像素:在ATSC标准中採纳了"方形像素"(Square Picture Eelements),由于它们更加适合于计算机:而DVB标准最初没有採纳.近期也採纳了.此外,范围广泛的视频图像格式也被DVB採纳,而ATSC对此则不作强制性规定. (2)系统层和视频编码:DVB和ATSC标准都採纳MPEG-2标准的系统层和视频编码,可是,因为MPE