云鹏杂记 之 编码规范

    前几天被一个同事问了个问题:
    IF vs_code = to_number(ii_code) THEN
这是一行Oracle PL/SQL代码,他问我写得对不对。
    且不说这个问题有多白痴,但只看一眼便可知道这行代码有问题。因为按照编码规范,变量应当使用v、i或o作为开头的第一个字符,以表示该变量为局部变量、输入参数或输出参数;第二个字符s则表示类型为VARCHAR2,i表示类型为INTEGER。从规范来看,这行代码应当写作:
    IF ii_code = to_number(vs_code) THEN
    虽然匈牙利命名法现在已经不再被推荐了,但从这个例子来看,在变量命名时标明类型依然是必要的。这样做不单便于自己阅读,也可以使别人对代码一目了然。
    说到这里,我倒想起另外一个问题,就是前几天看我们的编码规范,发现规范对段注释和行注释的运用说的十分不清楚,只是说有这么个东西,但具体在何时使用,就让编码人员自己看着办了。其实段注释和行注释从字面上理解,一眼也看得出该怎么使用,只是规范的范例给得实在很差:
    //名称
    String strName = null;
我觉得像这种情况根本没必要占用两行的空间,写作:
    String strName = null; //名称
就可以了,又不耽误阅读。但若是一行代码或注释较长,则应当使用段注释,甚至断行。
    此外,规范中对于段注释是使用//还是/* */也没有做明确规定。我个人认为应当使用//,毕竟注释再长也就几行。那么/* */在何时使用呢?我认为可以在废弃或临时注释大段代码时使用。虽然像Eclipse、PL/SQL Develop、Visual Studio这些IDE都提供了注释工具,不过也需要预防某些没有IDE可用的情况啊!

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值