代码规范化总结

落日映苍穹つ 2022-02-09 13:41 232阅读 0赞

作为一名程序员，我们在写代码的时候，需要注意以下几点：

***1.******命名规范***

取一个好听的名字是一种高情商的体现，那么给自己的代码取个简洁明了的名称也是专业化的体现，当然这要符合我们的命名规范。而且不能根据自己的喜好就随意起名，像什么水果啦、蔬菜了，这都是不可行的。大体规则如下：

··名字应该能够标识事物的特性，并且与业务挂钩。

··名字一律使用英文单词，而不能为拼音。

··名字可以有两个或三个单词组成，但不应多于4个，控制在3至30个字母以内。

··在名字中，多个单词用大写第一个字母（其它字母小写）来分隔。例如：IsSuperUser。

***2.******代码格式***

Tab缩进，每行都有对应的开始和结束，只有这样才能让自己的代码看起来更加有层次感，节奏感：

<li class="rotate-li">
        <a TARGET="_blank" href="" title="靓照">
            <img src="1.jpg" />
            <span>
                <script type="text/javascript">
                    var dTit = "";
                    var mTit = "靓照";
                    if (dTit != "") {
                        document.write(dTit);
                    } else {
                        document.write(mTit);
                    }
                </script>
            </span>
        </a>
    </li>

***3.******添加注释***

加上注释，让自己的代码会说话，这是为了让别人能够看懂，也是为了自己以后不会忘，更是为了保证代码的可读性，便于交流和维护。那么对于自己创建的代码文件：

***文件开头部分****，*我们一般可以这样编写注释：

/**********************************************
    
    作者：
    
    小组：
    
    说明：
    
    创建日期：
    
    版本号：
    
    **********************************************/

***而代码间注释****，*分为单行注释和多行注释：

*单行注释：*

//<单行注释>

*多行注释：*

/*多行注释1
    
    多行注释2
    
    多行注释3*/

代码中遇到语句块时需要添加注释,添加的注释必须能够说明此语句块的作用和实现手段（所用算法、循环条件、不同分支的意义等等）。