美文网首页
前端开发的命名规范

前端开发的命名规范

作者: 扎实小男孩 | 来源:发表于2020-01-15 14:57 被阅读0次

    命名的规范有多重要呢?因为我们的作品代码不仅仅是我们自己看的,如果我们是在一个团队开发中,我们自己所写的每一行代码也需要我们的队友可以一目了然。所以命名的规范是很有必要的,命名的规范可以大大提升你的代码的可读性。在你的作品代码中所有的名字我们都应该像我们的父母给我们起名字一样重视。

    【1】见名知义

    一个好的名字可以告诉所有阅读你的作品代码的人士:它是什么、为什么存在、该怎么用(有什么用)如果需要通过注释来解析则没有见名知义的效果了。

    【2】命名规则

    ①代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。

    eg:_name / __name / $name / name_ / name$ / name__ 

    ②代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。

    驼峰式命名:

    (1)lowerCamelCase小驼峰:第一个单词首字母小写。eg:studentInfo、userInfo、productInfo

    (2)UpperCamelCase大驼峰:每个单词首字母大写。eg:StudentInfo、UserInfo、ProductInfo

    一、文件资源命名:

    1、文件名不能含有空格。文件名建议只使用小写字母,不使用大写字母。( 为了醒目,某些说明文件的文件名,可以使用大写字母,比如README、LICENSE。 )

    2、文件名包含多个单词时,单词之间建议使用半角的连词线 ( - ) 分隔。

    3、引入资源使用相对路径,不要指定资源所带的具体协议 ( http:,https: ) ,除非这两者协议都不可用。

    不建议:

    <script src="http://cdn.com/foundation.min.js"></script>

    建议:

    <script src="//cdn.com/foundation.min.js"></script>

    二、包命名

    统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使 用单数形式,但是类名如果有复数含义,类名可以使用复数形式。

    eg:应用工具类包名为 com.alibaba.ai.util、类名为 MessageUtils

    三、变量命名

    命名方式:lowerCamelCase小驼峰

    eg:localValue / getHttpMessage() / inputUserId 

    命名规范:类型+对象描述的方式,如果没有明确的类型,就可以使前缀为名词

    类型与对应字母表示

    不建议:

    var tableTitle = "LoginTable"

    建议:

    var getTitle = "LoginTable" 

    四、常量命名

    命名方式:全部大写

    eg:MAX_STOCK_COUNT / CACHE_EXPIRED_TIME

    命名规范:使用大写字母和下划线来组合命名,下划线用以分割单词。

    建议:

    var MAX_COUNT = 10;

    var URL = 'http://www.baidu.com'; 

    五、方法名命名

    命名方式:lowerCamelCase小驼峰

    eg:localValue / getHttpMessage() / inputUserId 

    六、函数的命名

    命名方式:小驼峰方式 ( 构造函数使用大驼峰命名法 )

    命名规则 : 前缀为动词

    前缀动词

    eg:

    //是否可阅读

    function canRead(){ return true;}

    //获取姓名

    function getName{ return this.name};

    七、类的命名

    命名方式:UpperCamelCase大驼峰

    eg::JavaServerlessPlatform / UserDO / XmlService / TcpUdpDeal / TaPromotion

    避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命 名,使可读性降低。

    说明:子类、父类成员变量名相同,即使是 public 类型的变量也是能够通过编译,而局部变量在同一方法 内的不同代码块中同名也是合法的,但是要避免使用。对于非 setter/getter 的参数名称也要避免与成员 变量名称相同。

    public class ConfusingName {

        public int age;

        // 非setter/getter 的参数名称,不允许与本类成员变量同名

        public void getData(String alibaba) {

            if(condition) {

                final int money = 531;

                // ...

            }

        for (int i = 0; i < 10; i++) {

            // 在同一方法体中,不允许与其它代码块中的money命名相同

            final int money = 615;

            // ...

            }

        }

    }

    class Son extends ConfusingName {

        // 不允许与父类的成员变量名称相同

        public int age;

    八、.html/.jsp文件的命名

    命名方式:多个单词之间建议使用半角的连词线 ( _ ) 分隔。

    eg:send_email.html/send_email.jsp

    九、servlet的命名

    命名方式:UpperCamelCase大驼峰

    eg:RegisterServlet


    “此文章是作者在学习过程中得到身边的专业人士提点总结出来的一些知识点,小伙伴们在阅读过程中发现有问题欢迎大家提出来,一起学习修正。”

    相关文章

      网友评论

          本文标题:前端开发的命名规范

          本文链接:https://www.haomeiwen.com/subject/bovzactx.html