团队编程项目作业2-团队编程项目代码设计规范

标签：安全   嵌入   类型   嵌入式   山寨   线程安全   style   java类   javadoc   

一、前言：

本编程规范适用于编写HTML/CSS代码，本规范并不是一个一成不变的必须严格遵守的条文，特殊情况下应灵活应对，做到变通。

二、基本原则  

     1.对于捕获后，不知道干什么事情或者也不知道怎样处理的情况，就不要捕获异常，留给外出层去捕获处理；
     2.返回类型为集合的,在方法声明中必须使用泛型，必须在javadoc中注明什么情况下返回null，什么情况下返回空集合。
     3.对于方法、变量声明范围要采用如下优先级：private、protected、public，对于变量要采用如下的优先级：局部变量、实例变量、类变量，如果必须要采用实例变量或类变量的情况下，要保证线程安全性，如有可能尽量采用ThreadLocal保存实例变量或类变量；
     4.如果不是必须，不要在循环中去定义变量或者new 对象；尽量在需要的最后一刻才去new 对象；
     5.如果不是必须，不要在循环中去用try…catch;
     6.类中对于比较复杂的逻辑要采用行注释的方式进行注释，java代码中绝对不允许采用块注释（/**/）进行注释；
     7.Java类的名称第一个子母必须大写，有多个单词组成的，每个单词的首字母大写
     8.jsp的文件名必须全部小写；
     9.Spring的bean配置文件名必须小写，格式为xxx.bean.xml，xxx.bean.xml配置文件中的<bean id=”” ，此处的id，就是将类名的第一个字母小写放到此处。

三、 不要使用嵌入式CSS样式
当你在埋头写代码时，可能会经常顺手或偷懒的加上一点嵌入式css代码，就象这样：

<p style="color: red;">帕兰映像</p>

这样看起来即方便又没有问题，但是它会在你得代码中产生问题。
在你开始写代码时，最好是在内容结构完成之后再开始加入样式代码。

这样的编码方式就像打游击，是一种很山寨的做法。——Chris Coyier

更好的做法是，把这个P的样式定义在样式表文件里：

someElement > p {
color: red;
}

团队编程项目作业2-团队编程项目代码设计规范

标签：安全   嵌入   类型   嵌入式   山寨   线程安全   style   java类   javadoc   

原文地址：http://www.cnblogs.com/cuiwenlong/p/7977569.html