欢迎访问移动开发之家(rcyd.net),关注移动开发教程。移动开发之家  移动开发问答|  每日更新
页面位置 : > > 内容正文

Node.js编码规范,node.js编码

来源: 开发者 投稿于  被查看 40438 次 评论:183

Node.js编码规范,node.js编码


调用函数的时候,函数名与左括号之间没有空格。

函数名与参数序列之间,没有空格;所有其他语法元素与左括号之间,都有一个空格。

使用小驼峰式命名法作为所有变量和属性的命名规则。
缩进使用两空格,统一使用单引号。
关联数组,除非键名中有空格或是非法字符,否则一律不用引号。
不要将不同目的的语句,合并成一行。
不要省略句末的分号,哪怕一行只有一个语句。
不要使用自增(++)和自减(--)运算符,用+=和-=代替。
不要使用"相等"(==)运算符,只使用"严格相等"(===)运算符。
所有变量声明都放在函数的头部。
所有函数都在使用之前定义。
尽量给构造函数和回调函数命名,这样当你在调试的时候可以看见更清晰的调用栈。
尽量将所有的成员函数通过原型定义,将属性在构造函数内定义,然后对构造函数使用new关键字创建对象。
避免复杂的继承,如果要继承,尽量使用util模块中的inherits函数。比如A继承B,可以util.inherits(A,B)。


参考资料:
《Node.js开发指南》附录B(BYVoid)

Javascript编程风格(阮一峰)



文档信息

  • 版权声明:自由转载-非商用-非衍生-保持署名 | Creative Commons BY-NC-ND 3.0
  • 原文网址:http://blog.csdn.net/cdztop/article/details/37749051
  • 最后修改时间:2014年07月14日 01:50


JAVA编码规范

(1) 类名首字母应该大写。字段、方法以及对象(句柄)的首字母应小写。对于所有标识符,其中包含的所有单词都应紧靠在一起,而且大写中间单词的首字母。例如:
ThisIsAClassName
thisIsMethodOrFieldName
若在定义中出现了常数初始化字符,则大写static final基本类型标识符中的所有字母。这样便可标志出它们属于编译期的常数。
Java包(Package)属于一种特殊情况:它们全都是小写字母,即便中间的单词亦是如此。对于域名扩展名称,如com,org,net或者edu等,全部都应小写(这也是Java 1.1和Java 1.2的区别之一)。
(2) 为了常规用途而创建一个类时,请采取"经典形式",并包含对下述元素的定义:
equals()
hashCode()
toString()
clone()(implement Cloneable)
implement Serializable
(3) 对于自己创建的每一个类,都考虑置入一个main(),其中包含了用于测试那个类的代码。为使用一个项目中的类,我们没必要删除测试代码。若进行了任何形式的改动,可方便地返回测试。这些代码也可作为如何使用类的一个示例使用。
(4) 应将方法设计成简要的、功能性单元,用它描述和实现一个不连续的类接口部分。理想情况下,方法应简明扼要。若长度很大,可考虑通过某种方式将其分割成较短的几个方法。这样做也便于类内代码的重复使用(有些时候,方法必须非常大,但它们仍应只做同样的一件事情)。
(5) 设计一个类时,请设身处地为客户程序员考虑一下(类的使用方法应该是非常明确的)。然后,再设身处地为管理代码的人考虑一下(预计有可能进行哪些形式的修改,想想用什么方法可把它们变得更简单)。
(6) 使类尽可能短小精悍,而且只解决一个特定的问题。下面是对类设计的一些建议:
一个复杂的开关语句:考虑采用"多形"机制
数量众多的方法涉及到类型差别极大的操作:考虑用几个类来分别实现
许多成员变量在特征上有很大的差别:考虑使用几个类
(7) 让一切东西都尽可能地"私有"--private。可使库的某一部分"公共化"(一个方法、类或者一个字段等等),就永远不能把它拿出。若强行拿出,就可能破坏其他人现有的代码,使他们不得不重新编写和设计。若只公布自己必须公布的,就可放心大胆地改变其他任何东西。在多线程环境中,隐私是特别重要的一个因素--只有private字段才能在非同步使用的情况下受到保护。
(8) 谨惕"巨大对象综合症"。对一些习惯于顺序编程思维、且初涉OOP领域的新手,往往喜欢先写一个顺序执行的程序,再把它嵌入一个或两个巨大的对象里。根据编程原理,对象表达的应该是应用程序的概念,而非应用程序本身。
(9) 若不得已进行一些不太雅观的编程,至少应该把那些代码置于一个类的内部。
(10) 任何时候只要发现类与类之间结合得非常紧密,就需要考虑是否采用内部类,从而改善编码及维护工作(参见第14章14.1.2小节的"用内部类改进代码")。
(11) 尽可能细致地加上注释,并用javadoc注释文档语法生成自己的程序文档。
(12) 避免使用"魔术数字",这些数字很难与代码很好地配合。如以后需要修改它,无疑会......余下全文>>
 

HTML编码有什规范要?

1.HTML编码规范
HTML并不是一种编程语言,而是一种标记语言,它没有任何真正的编程语言中的循环或是流程控制语句。然而,HTML代码的格式和风格是非常重要的,因为要经常对HTML代码进行维护和修改,因此HTML代码必须有很清晰的逻辑结构和布局,而使其易懂和易于维护。

1.1 标记的书写
HTML语言是不区分大小写的,但一般来说,标记使用大写书写,如<P>, <HTML>, <TABLE>等;标记中的属性一般使用小写,如<A href=”a.html”>, <font size=”5”>等。

1.2 标记的换行规范

一般一个HTML代码都会很长很复杂,因此不要把代码写得很密,这样的可读性非常差,HTML对回车和空格都不敏感,因此可以使用回车和空格,使代码的格式和结构更清晰,这样才能易于维护。很多标记一般来说要占用一行,除了同一标记的关闭标记外,最好不出现两个标记在同一行的情况。如:

<TABLE><TR><TD>text</TD></TR></TABLE>

应写成:

<TABLE>

<TR>

<TD>text</TD>

</TR>

</TABLE>

1、 通常情况下,应该换行的标记有:

Ø <HTML>和</HTML>

Ø <BODY></BODY>

Ø <HEAD></HEAD>

Ø <FORM></FORM>

Ø 当段落内容比较长时,<P></P>也应各占一行

Ø 各种列表标记

Ø 表格的相关标记

Ø <BLOCKQUOTE>和</BLOCKQUOTE>

Ø <PRE>和</PRE>

Ø <CODE>和</CODE>

2、 通常情况下,需要将开始和关闭标记放在一行的标记有:

Ø <B>和</B>

Ø <U>和</U>

Ø <I>和</I>

Ø 各种标题标记,如<H1>…</H1>等

Ø <A>和</A>

1.3 标记的关闭规范:
1、 HTML文档的正文都应在<BODY></BODY>标记中间,而<BODY>标记则应包含在<HTML>和</HTML>标记之间,如

<HTML>

<BODY>

…………

&l......余下全文>>
 

相关频道:

用户评论