编写可读性强的代码

以下是编写可读性强的代码的准则:

  • 使用注释描述程序或脚本,包括作者、日期和修改说明。
  • 让每个主要的 Transact-SQL 子句单独占一行,以使语句更易于阅读:
    USE pubs
    SELECT au_fname, au_lname
    FROM authors
    WHERE state = 'CA'
    
  • Transact-SQL 关键字(如 SELECT 和 FROM)、函数名(如 SUM、AVG、DATEPART、CASE 和 CONVERT)以及数据类型(如 INT、CHAR、NTEXT)都用大写:
    USE pubs
    CREATE TABLE myauthors
    (
     first VARCHAR(30) NOT NULL,
     last VARCHAR(40) NOT NULL,
     address VARCHAR(40) NOT NULL,
     city VARCHAR(30) NOT NULL,
     state VARCHAR(2) NOT NULL,
     zip CHAR(9) NOT NULL,
     phone VARCHAR(20) NULL
    )
    
  • 定义并统一使用对象名的风格约定。以下是两项典型的约定:
    • 名称的每个部分的首字母大写;名称的各部分不用下划线隔开:TableName
    • 所有的字符都小写,并用下划线 (_) 隔开名称的各部分:table_name

    即使当前的 Microsoft® SQL Server™ 实例不区分大小写,如果使用一致的风格,也可以提高可读性。在编写 Transact-SQL 语句中的对象名时,始终与定义该对象所用的大小写严格保持一致,也是一个好方法。

  • 对于您单位中常用的对象,定义一组标准缩写,统一用作对象名称。
  • 所有字符、字符串、二进制数据和 Unicode 常量都使用单引号,以便引用的标识符是唯一使用双引号 (") 的项目。
  • 当使用多表联接时,用易写和易记的别名。例如,将 t 作为 titles 表的别名,将 a 作为 authors 表的别名。
  • 如果某个 Transact-SQL 关键字后面的信息要折到下一行,请考虑将第二行和其后的行缩进一个制表位(通常是 5 个空格),使查找主关键字更方便。
  • 使用圆括号表示复杂数学计算的执行顺序。这将提高可读性。例如,使用"(price * 1.15) + sales"而不是"price * 1.15 + sales"。

转载于:https://www.cnblogs.com/kaixin110/archive/2008/05/10/1190970.html

你可能感兴趣的:(编写可读性强的代码)