软件工程—编码规范

Posted qhu-hjx

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了软件工程—编码规范相关的知识,希望对你有一定的参考价值。

WXML编码规范总结

1、 缩进

在有缩进的地方统一采用4个空格,不采纳8个空格或者2个空格或者Tab键,最不建议采用Tab键,它会在不同的环境下显示不同的长度。

例:

        技术分享图片

 

2、 行宽

采用每行不超过100个字符为标准,超过100个字符显得代码行宽过长,影响阅读。

例:

技术分享图片

 

3、 分行

不采用多条语句同时放置在同一行上,即使该行原本的语句较短,也只能让其独占一行,每条语句都只占一行,不允许一行多条代码的出现。

例:

技术分享图片

 

4、 容器的使用

对一个模块的内容,用一个容器进行包括,保证代码的可阅读性,也能够使整个布局有清晰的条例结构,以便后续代码的修改提供了方便。

例:

技术分享图片

 

5、 函数的绑定

对于button(按钮)或者Input(输入框)等组件,需要绑定对应的函数,以便响应对应的事件,不能使其是一个“纸老虎“。

例:

技术分享图片

 

6、 属性

对每个组件,都有各自的属性,需要确定其各自的属性。

例:

技术分享图片

 

7、 命名以及大小写

对每个标签中对应的属性都需要小写,每个属性值首字母大写,遇到多个单词的用“ - ”连接或者每个单词首字母大写来区分。也采用Camle方法命名。

例:

技术分享图片

技术分享图片

 

8、 注释

对每个块或者容器所实现的功能或界面进行注释,便于阅读。

例:

技术分享图片

 

 

WXSS编码规范总结

1、 缩进与行宽

在有缩进的地方统一采用4个空格,不采纳8个空格或者2个空格或者Tab键,最不建议采用Tab键,它会在不同的环境下显示不同的长度。行宽采用每行不超过100个字符为标准,超过100个字符显得代码行宽过长,影响阅读。

例:

              技术分享图片

 

2、{ }的使用

无论是判断语句,或者循环语句,即使在其作用域内只有一条语句,也使用{ },将所属的块涵盖,“{” 和 “}” 都占用一行,更能够使代码的条例清晰,代码的结果明确和对应的关系直当明了。

例:

技术分享图片

 

3、分行

不采用多条语句同时放置在同一行上,即使该行原本的语句较短,也只能让其独占一行,每条语句都只占一行,不允许一行多条代码的出现。

例:

                     技术分享图片

 

4、命名以及大小写

对每个样式的命名需要由WXML中的命名来决定。采用Camle和Pascal方法命名。

例:

       技术分享图片

 

 

 

javascript编码规范总结

 

1、 括号

对复杂的条件判定中,需要加上对应的圆括号,使得复杂的条件判定更易阅读和理解,也能使条件的判断准确无误。

例:

技术分享图片

 

2、{ }的使用

无论是判断语句,或者循环语句,即使在其作用域内只有一条语句,也使用{ },将所属的块涵盖,“{” 和 “}” 都占用一行,更能够使代码的条例清晰,代码的结果明确和对应的关系直当明了。

例:

技术分享图片

 

3、缩进

在有缩进的地方统一采用4个空格,不采纳8个空格或者2个空格或者Tab键,最不建议采用Tab键,它会在不同的环境下显示不同的长度。

例:

        技术分享图片

 

4、 行宽

采用每行不超过100个字符为标准,超过100个字符显得代码行宽过长,影响阅读。

例:

技术分享图片

 

5、 分行

不采用多条语句同时放置在同一行上,即使该行原本的语句较短,也只能让其独占一行,每条语句都只占一行,不允许一行多条代码的出现。

例:

技术分享图片

 

6、 函数的编写格式及变量修改与访问

函数由function 函数名(参数){  }的格式进行编写,在page()中使用函数名:function(){  }的格式进行编写,在page()中修改data中的值时,需采用this.setData({})进行修改,访问时使用this.data.变量名进行访问。

例:

技术分享图片

 

7、 空格

对每个二元运算符或者第一个花括号前添加上空格,是代码更具有阅读性。

例:

技术分享图片

 

技术分享图片

 

8、 命名以及大小写

对每个变量采用唯一化的命名方式,采用Camle和Pascal方法命名。让变量具有唯一性,明白变量代表的含义,也便于代码的复审和修改。

例:

        技术分享图片

 

9、 注释以及条件判断

对每个块或者函数所实现的具体功能进行注释,便于理解函数的具体作用。在条件判断中使用“===”进行判断,只有类型以及值都相等时判断为真。

例:

技术分享图片

 

技术分享图片

 

 

以上是关于软件工程—编码规范的主要内容,如果未能解决你的问题,请参考以下文章

软件开发规范四《应用系统安全编码规范》

Android编码规范

Android编码规范

java编程规范

软件工程—编码规范

软件开发规范六《Android开发编码规范》