Naming specification / annotation specification / logical specification

In order to improve the readability of the code , And other follow-up personnel for easy search 、 Modify the code , The following specifications can be followed ：

1. Naming specification ：
（1）id/class Use the middle dash nomenclature , for example article-title、article-content; Hump naming method is adopted for variable naming, for example articleList、articleInfo

（2） Name in English instead of Chinese , For example, the page header should be named header, instead of toubu

（3） Try not to abbreviate , Unless it is a word that can be understood at first sight , for example nav

（4） The naming of variables should use easy to understand words or phrases , Avoid using data、value And so on , Use the singular, not the plural . For example, using articleInfo、articelList Don't use articlesList、articleLists

（5） for fear of class The repetition of names , When naming, it usually takes the name of the parent element class Name as a prefix , for example ：

<div class="column>
    <h3 class="column-title></h3>
    <div class="column-content></div>
</div>

（6） To avoid ambiguity , When naming variables, try to use word combinations . for example ： use provinceCode For the province code, use provinceName Indicates the name of the province , If only province, It is easy to confuse the data stored in this variable . Words that are easy to understand do not have to use word combinations , for example phone It usually means telephone number .

（7） Method name ： Verb + Noun , for example getArticleList Means to get the article list 、submitArticleInfo Means to submit article information 、goAddPage Jump to the new page 、showDetailModal/closeAddModal To show / Close the pop-up window for details

2. Annotation specifications

（1） Module annotation ： Add comments at the beginning or end of the module , Description plus “start”、“end”, Easy to locate . for example ：

<!-- Navigation start-->
    ...
<!-- Navigation end-->

/* Article list style start*/
    ...
/* Article list style end*/

3. Logical norms

Use if When branching statements , To avoid excessive code embedding （ Constantly indent to the right ）, Use the writing method of negative logic judgment , And handle exceptions ; The main logic should be positive . The code example is as follows ：

    if( Cannot continue to execute logical decision expression ) {
        /* Error prompt or throw exception */
        return
    }
     The correct business logic continues