如何让编码更加的标准

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语句后面

public void getAppDetail(App app){

    if(app != null){
       // 业务逻辑处理
    }else{
       // 若没有业务逻辑处理,此处也需要加上,可以打印一条log
       log.info("App object is null");
    }  

}

  在书写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-03 16:49:23

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

HTML与javascript中常用编码

  在日常的前端开发工作中,我们会经常的与HTML.javascript.css等语言打交道,和一门真正的语言一样,计算机语言也有它的字母表.语法.词法.编码方式等,在这里我简单的谈一下前端HTML与javascript日常工作中常碰到的编码问题. 在计算机中,我们储存的信息都是用二进制码表示的.我们认识的.屏幕上显示的英文.汉字等符号和储存用的二进制代码的互相转换,就是编码. 有两个基本概念需要说明,charset 和 character encoding: charset ,字符集,也就是某

java中文乱码解决之道(二)—–字符编码详解:基础知识 + ASCII + GB**

一.基础知识 在了解各种字符集之前我们需要了解一些最基础的知识,如:编码.字符.字符集.字符编码基础知识. 编码 计算机中存储的信息都是用二进制表示的,我们在屏幕上所看到文字.图片等都是通过二进制转换的结果.编码是信息从一种形式或格式转换为另一种形式的过程,通俗点讲就是就是将我们看到的文字.图片等信息按照某种规则存储在计算机中,例如'c'在计算机中怎么表达,'陈'在计算机中怎么表达,这个过程就称之为编码.解码是编码的逆过程,它是将存储在计算机的二进制转换为我们可以看到的文字.图片等信息,它体现的

HTML与javascript常碰到的编码问题第1/2页_javascript技巧

在这里我简单的谈一下前端HTML与javascript日常工作中常碰到的编码问题.在计算机中,我们储存的信息都是用二进制码表示的.我们认识的.屏幕上显示的英文.汉字等符号和储存用的二进制代码的互相转换,就是编码. 有两个基本概念需要说明,charset 和 character encoding: charset ,字符集,也就是某个符号和某个数字映射关系的一个表,也就是它决定了107 是koubei 的 'a',21475 是口碑的"口",不同的表有不同的映射关系,如 ascii,gb

ITU批准H.265视频标准 比H.264减少一半带宽

国际电信联盟的一个组织已经批准H.264视频编码标准的后续标准,为未来的视频传输敞开了大门.采用这个标准传输视频所需要的带宽仅是目前所需带宽的一半.随着显示屏分辨率在未来10年里不断提高,国际电信联盟的H.265标准将帮助在智能手机.平板电脑.电视机和其它设备之间传送视频.这个标准将帮助减少有线和无线网络的负担.视频目前占这些网络流量的很大一部分.随着产品和服务的增长超过目前的技术限制,厂商和服务提供商 预计将逐步采用这个新标准.国际电信联盟称,名为MPEG-4的当前的技术规格是世界上使用最多的

AVS2标准颁布 超高清时代真的要来了

走过模拟.标清.高清时代,视频监控对于清晰度的追求远远不止步于此,4K的出现,引领安防行业走向超高清时代.然而,编解码技术无法满足4K的需求是一直阻碍4K难以真正到来的原因之一. 随着我国第二代数字视频编码标准AVS2的颁布,并作为为广播电视行业标准,将应用于超高清电视和视频监控,且编码效率领先于最新国际标准,标志着我国视频技术和产业正式进入"超高清"和"超高效"的"双超时代". 发展历程 AVS(Audio Video coding Stand

XML文件的解析--libxml库函数解释

xml|函数 libxml(一)                                     摘要 Libxml是一个有免费许可的用于处理XML.可以轻松跨越多个平台的C语言库.这个指南提供它的基本函数的例子.绪论 Libxml 是一个实现读.创建及操纵XML数据功能的C语言库.这个指南提供例子代码并给出它基本功能的解释.在这个项目的主页上有Libxml及更多关于它可用的 资料.包含有完整的API文档.这个指南并不能替代这些完整的文档,但是阐明功能需要使用库来完成基本操作.    这

深度探讨PHP之性能

  1.缘起 关于PHP,很多人的直观感觉是PHP是一种灵活的脚本语言,库类丰富,使用简单,安全,非常适合WEB开发,但性能低下.PHP的性能是否真的就 如同大家的感觉一样的差呢?本文就是围绕这么一个话题来进行探讨的.从源码.应用场景.基准性能.对比分析等几个方面深入分析PHP之性能问题,并通过真 实的数据来说话. 2.从原理分析PHP性能 从原理分析PHP的性能,主要从以下几个方面:内存管理.变量.函数.运行机制来进行分析. 2.1内存管理 类似Nginx的内存管理方式,PHP在内部也是基于内

使用 HTTP 访问 SQL Server

server|访问 使用 HTTP 访问 SQL Server可以使用 HTTP 访问 Microsoft SQL Server 2000.在可以使用 HTTP 指定查询前,必须先用用于 SQL Server 的 IIS 虚拟目录管理实用工具创建一个虚拟根. SQL Server 的 HTTP 访问能力使您得以: 直接在 URL 中指定 SQL 查询,例如: http://IISServer/nwind?sql=SELECT+*+FROM+Customers+FOR+XML+AUTO&root=

使用用于SQL Server的IIS虚拟目录管理实用工具

iis|server|虚拟目录 在使用 HTTP 访问 Microsoft? SQL Server? 2000 数据库之前,必须安装适当的虚拟目录.在运行 Microsoft Internet 信息服务 (IIS) 的计算机上,使用用于 SQL Server 的 IIS 虚拟目录管理实用工具(在"SQL Server 工具"程序组中单击"在 IIS 中配置 SQL XML 支持")定义并注册新的虚拟目录,即所谓的虚拟根.该实用工具指示 IIS 在新的虚拟目录和 Mi