编码标准之格式

编码标准之格式

阅读导航

SQL关键字

代码缩进

注释

括号

空格

代码就像家里的各种物品，格式化就好比对家中物品的排放。家中的物品随便怎么放，物品都不会反对，房子也不会介意，但是物品的排放合理、规整，会让家里变得更具有美感。代码也是一样，代码写成什么样子，代码不会反对，计算机也不会介意（除非不能运行），但是毕竟还是会有人来欣赏、维护这些代码，这时候具有很好格式的代码就显得尤为重要了。

 

SQL关键字

所有的SQL关键字大写。

SELECT，UPDATE，DELETE，INSERT INTO，CRETAE DATABASE，ALTER DATABASE，CREATE TABLE，ALTER TABLE，DROP TABLE，CREATE INDEX，DROP INDEX，LIKE，IN，INSERT、LEFT、RIGHT、FULL JOIN，CONSTRANIT，UNIQN，CHECK，VIEW等等。

CREATE DATABASE myDemo;

CREATE TABLE Orders
{
    [OrdersID] int NOT NULL,
    [OrdersNo] int  NOT NULL,
    [CreateDate] datetime NOT NULL DEFAULT GETDATE(),
    [Decription] varchar(200),
    [CustomersID]  int NOT NULL
}

ALTER TABLE Orders
ADD CONSTRAINT pk_OrdersID PRIMARY KEY ([OrdersID])

ALTER TABLE Orders
ADD CONSTRAINT fk_Orders_Customers
FOREIGN KEY ([CustomersID])
REFERENCES Customers([Customers])

SELECT Customers.CustomersName, Orders.OrdersID
FROM Customers
INNER JOIN Orders
ON Customers.CustomersID=Orders.CustomersID
ORDER BY Customers.CustomersName

 

代码缩进

为了提高代码美感和可读性，代码缩进是必不可少的。一般的缩进的标准是以四个空格为单位或TAB键为单位，

IF NOT EXISTS( SELECT [OrdersID] FROM [Orders]
            WHERE [CustomersID] = @CustomersID AND
            [OrdersNo] = @OrdersNo )
BEGIN
    INSERT INTO [Orders]
    (
        [OrdersID],
        [OrdersNo],
        [CreateDate],
        [Decription],
        [CustomersID]
    )
    VALUES
    (
        NEWID(),
        @OrdersNo,
        GETDATE(),
        '',
        @CustomersID
    )
    SET @error = @@ERROR
    IF (@error <> 0) GOTO ExitPoint
END

 

注释

代码逻辑更易懂，最好添加表要的注释，这样对于codereview和维护都是有大大滴好处。

“--”：单行注释

“/*……*/”：多行注释

-- 创建名字为myDemo的数据库
CREATE DATABASE myDemo;
/*
创建数据库表
表名为Orders
*/
CREATE TABLE Orders
{
[OrdersID] int NOT NULL
}

 

括号

使用括号增加可读性

SELECT [OrdersID]
FROM [ORDERS]
WHERE
(
    CustomersID = '12345678'
    AND ([Description] LIKE '%computer%' OR [Description] LIKE '%phone%'
)

 

空格

SQL内算数运算符和逻辑运算符连接的两个元素须用空格分隔。逗号如果不是一行的结束，要在逗号后面加空格。

代码示例请参照上面的例子

应该还有很所关于格式化的规则，由于本人设计数据尚浅，接触的数据库也不是特别多，还希望大家帮忙补充

---

在此谢谢读完这篇博客，有什么写的不对的地方请指正。
有帮助就推荐下，有感想就写下留言，不满意也写下留言，有问题及时更正。

学习坚持，坚持学习

Boyce

 

分类: SQL

标签: 数据库