我的未来编码规范

Posted huang麦穗儿

tags:

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

.Net

命名规范

  1. 文件夹、实体命名统一使用英文定义,以大驼峰命名法。不宜过长可简拼,具有可读性。   
  2. 变量命名使用英文定义,以小驼峰命名法。不宜过长可简拼,具有可读性。

Student

  1. 增删改查方法命名统一规范。

a)         各种查询

  1. GetXXXX/GetXXByXX 获取XXXX信息。 例如GetUserList 获取用户信息集合(多条)/GetUserByName、GetUserListByAge等。
  2. FindByXX 查找 定义通用的查找方法时候使用。 例如FindByOID 通过主键获取信息。
  3. QueryByXXXX 查询 定义通用查询方法时候可使用。例如QueryBySql、QueryByHql 通过sql或者hql 查询数据信息等。

 

b)        SaveXXXX 保存XXX 例如:SaveUserInfo 保存用户信息。

c)         XXXXAdd 例如:TreeNodeAdd 树添加。

d)        XXXXUpdate  XXXX修改 TreeNodeUpdate 树修改、BatchUpdate批量修改。

e)         XXXXDelete   XXXX删除  TreeNodeDelete 树删除。

注明:By 通过XXX处理信息。关键字在前和后的统一,是根据现有.Net框架中规范定义,如果Java觉得不适应,可改为统一在前或者统一在后。

  1. 接口名称定义 以I开头。
  2. 禁止出现以包含数字命名和汉字拼音或者汉字命名。

 

框架层之间命名

实体层:Domain

数据访问层:DAL

业务逻辑层:BLL

通用层:Common

注释应用

  1. // 单行注释
  2. /**/ 块注释
  3. ///说明注释,注释以后可以自动生成说明文档

 

  1. #region  折叠注释,可以将 代码折叠,
    只是#region 所在行后面的文字是注释文字,而其它的#region和#endregion之内的行代码是有效的,仅仅起折叠作用
    #endregion

 

Web前端编码规范

命名及代码规范

1、变量、属性、方法名:小驼峰命名,不宜过长可简拼,具有可读性。

2、常量、类名:大驼峰命名,不宜过长可简拼,具有可读性。

3、引号默认使用单引号。

4、html页面名,css页面名,Js页面名使用大驼峰命名法。

5、class类名,id名,小驼峰命名法。

6、图片命名:如果是作为背景图片bg_图片名,其他图片为img_图片名。

7、图片有透明效果的用png格式,其他最好用jpg格式

8、非特殊情况下样式文件引用必须写在<head>…</head>之间,JavaScript文件引用必须写在页面底部。

9、尽可能减少div嵌套, 如<div><div class=”welcome”>欢迎访问XXX, 您的用户名是<div class=”name”>用户名</div></div></div>完全可以用以下代码替代: < div><p>欢迎访问XXX, 您的用户名是<span>用户名</span></p></div>;

10、在页面中尽量避免使用style属性,即style=”…”;,即html与css相互独立

11、能以背景形式呈现的图片, 尽量写入css样式中; 写样式时,如果所修饰标签有父级,则写类名时,把父级带上,例如:

<div class=”newsDiv”>

<div class=”newsTitle”>

</div>

</div>

. newsDiv  . newsTitle{}

 

 

12、制作页面时,要考虑用户体验,如Table标签中的td字数超长的要加上title属性

 

<table><td id =”c” title = “备注” ></td></table>

 

 

注释应用

块注释:

/* 代码块说明文字

* Create by Name 2017.01.03

* Edit by Name 2017.01.03

* 参数1:参数说明

* 参数2:参数说明

* return:返回值说明

*/

单行注释:

//注释说明文字

要求

  1. 在extframe 菜单中配置html权限的时候 路径必须小写。
  2. 所有页面a标签的url路径必须小写。
  3. 每一个页面的js,css,html 名称要一致。
  4. 后台方法必须要写明XML注释,GET方法需要写清楚每个参数的含义,POST方法需要将对象属性写清楚如“{OID:””,NAME:””,USER:{“OID”:””}}”
  5. 页面引用的路径都需要以”/Areas”层级为头。如:

“<a href=”/areas/zzicec/web/index.html”>”

  1. 6.        功能实现后要测试IE9,谷歌浏览器,火狐浏览器,360浏览器极速模式下的兼容性。
  2. Form表单验证输入框错误提示的时候一定要focus();光标定位,验证信息使用Bootstrap的Toolip显示。要求数据表单验证的一致性。

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

Javascript编码规范

我的编码习惯 - 配置规范

我的Java编码规范

智能合约最佳实践 之 Solidity 编码规范

智能合约最佳实践 之 Solidity 编码规范

Kotlin编码规范