web开发之菜鸟的代码规范

笔者菜鸟里最不会飞的那个,所以这些基础的习惯都没养成,正好抽时间特意做个笔记以方便自己规范代码, 有兴趣的大佬多多指点.

养成好的编码习惯收益良多, 总结下编码时应注意的细节《借鉴高程里代码约束》,对了默默吐槽下,说是前端不需要英语基础的那些机构们真的是为了钱失了智;

a .命名约束:匈牙利命名/驼峰命名/帕斯卡命名法

匈牙利命名:此命名方法可细分为系统匈牙利命名法和匈牙利应用命名法。

  -> 语法:变量名 = 类型 + 描述

  ->约定类型:

    a --- array

    o --- object

    s --- string

    l --- float

    fn --- function

    i --- int

    r --- regular

    b --- boolean

驼峰命名(小驼峰命名法):第一个单词以小写字母开始,后面的所有单词的首字母都采用大写字母;

帕斯卡命名(大驼峰命名法):每一个单字的首字母都大写;

1.变量命名: 名词

2.方法命名: 动词

->常见动词约定:

  can ---  判断是否可执行某个动作

  has --- 判断是否有某个值

  is ---  判断是否为某个值

  get --- 获取某个值

  set --- 设置某个值

  load --- 加载一些数据

3.特殊函数/变量非硬性约定命名:

  1): 常量:全部大写单词之间用"_"划分;

  2): 构造函数: 大驼峰命名;

  3): 私有成员(属性/方法): 以"_"为前缀;

b. 编码非硬性原则:

1.事件Event对象不传递, 如有需要只传需要的数据即可;

2.应用层逻辑可以不依赖任何行为进行;

3.事件层只处理事件;

4.代码职责单一 ;

5.尊重对象所有权即只修改自己创建的对象;

6.避免全局变量;

c. 代码性能

1.避免全局查找与尽量减少查找作用域链长度;

2.with,eval,setTimeout第一个参数字符形式,Function 避免使用;

3.循环优化

  ->减值迭代

  ->简化终止条件

  ->简化循环体

  ->尽量使用后测试循环即 do-while

4.最小化语句数;

5.对数值操作位运算更快;

6.优化dom操作(这块有很多东西需要研究一时半会也就不分享了);

d:代码注释常用标识符:

[email protected] 程序的作者说明

[email protected] 源文件的版本说明

[email protected] 方法的参数说明

[email protected] 不建议的使用方法

[email protected] 方法的返回值的说明信息

[email protected] 参见,用于指定参考内容

[email protected] 抛出的异常类型

[email protected] 抛出的异常

[email protected] 示例代码

笔记这么多.慢慢培养了;

时间: 2024-10-16 07:23:55

web开发之菜鸟的代码规范的相关文章

团队开发前端VUE项目代码规范

团队开发前端VUE项目代码规范 2018年09月22日 20:18:11 我的小英短 阅读数 1658 一.规范目的: 统一编码风格,命名规范,注释要求,在团队协作中输出可读性强,易维护,风格一致的代码 二.开发SRC目录: 1.Vuex目录 (状态树配置) 2.Router目录(路由配置) 3.Pages目录 (放置主路由组件 注意命名规范) 4.Common目录 (放置静态文件) 5.Config目录 (全局配置项,路由拦截,报错信息,等枚举信息) 6.Api目录 ( 相关全局请求调用配置.

【Android 应用开发】 Android 相关代码规范 更新中 ...

. 简介 : Android 常用的代码结构, 包括包的规范, 测试用例规范, 数据库模块常用编写规范; 参考 : 之前写的一篇博客 [Android 应用开发] Application 使用分析 ; -- Application 分析 : Application 概念, 声明周期, 组件间传递数据作用, 数据缓存作用; -- 源码分析 : 分析 Application 结构接口源码; -- 使用示例 : 自定义 Application 注册, 保存崩溃日志到文件, 监听Activity声明周期

iPhone开发:Objective C 代码规范-iOS总结版

一,关于空行 A:.h中的空行 1,文件说明与头文件包涵(#import)之间空1行 2,头文件包涵(#import)之间,如果需要分类区别,各类别之间空1行 3,头文件包涵(#import)与@class之间空2行 4,@interface与@class之间空一行 5,头文件{}里面,空1行开始声明对象成员,如果需要分类区别,各类别之间空1行 6,{}外空1行,书写属性,如果需要分类区别,各类别之间空1行 7,空1行开始写方法,如果需要分类区别,各类别之间空1行 8,方法完成后,空1行@end

Java Web开发入门之Servlet代码篇(三)

1. ServletConfig获取参数&测试实例化/初始化/销毁方法 public class Servlet01_ServletConfig extends HttpServlet { public Servlet01_ServletConfig() { System.out.println("实例化~~~~~~~~~~"); } @Override public void init() throws ServletException { System.out.printl

几款web开发常用jquery特效代码

特效网:http://www.xwcms.net 1.图片拖动特效http://www.xwcms.net/js/tpdm/32946.html2.弹出层焦点图特效:http://www.xwcms.net/js/tpdm/20571.html3.标题悬停效果动画SVG图标http://www.xwcms.net/js/tpdm/98394.html4.jquery制作浏览器调整大小-监控动作进度小插件http://www.xwcms.net/js/qttx/29373.html5.jquery

Java&Android代码规范

项目中直接导入Square的代码风格文件.(不导入Google的原因是Square同时提供了Java和Android两套统一风格,Google只提供了一套) Square Code Styles Goolge Code Styles 导入后会有很多好处,如注释规范化,import规范,方法排序,统一自动断行(PC屏幕较宽,建议断行字符数设置为120[File->Setting–>Code Style,右边Right Margin Columns])等 而在编码保存或提交时还能自动格式化代码,删

从任正非公开信说起,谈代码规范的重要性!

最近的1月2号,任正非发布了题为<全面提升软件工程能力与实践,打造可信的高质量产品>致全体员工信,这也是今年华为总裁办签发的2019年001号文件.在信中,任正非强调了高质量软件产品的关键特性,呼吁各软件工程师理解架构的核心要素.重视代码质量.遵循业界共识的标准和规范,并计划用5年时间投入20亿美元全面提升华为软件质量. 任正非的公开信 在我的印象中,关于某某公司宣布重金投入一个领域.一个产品的新闻有很多,比如某度和某米的all in:但华为这次却很不一样,20亿美元的投入点居然单纯是冲着软件

web前端开发代码规范

1. 引言 对于一个多人团队来说,制定一个统一的规范是必要的,因为个性化的东西无法产生良好的聚合效果,规范化可以提高编码工作效率,使代码保持统一的风格,以便于代码整合和后期维护.本文档主要描述web项目开发中所使用的html.css.JavaScript等规范,请参与开发相关人员遵循,同时也请各位日后进行补充完善. 2. HTML/CSS规范 2.1 浏览器兼容 根据业务要求而定: 主流程测试:Chrome 30+.IE9+: 完整测试: Chrome 21.IE8+.360浏览器.微信webv

MiS603开发板 2.1 Verilog HDL 代码规范

作者:MiS603开发团队 日期:20150911 公司:南京米联电子科技有限公司 论坛:www.osrc.cn 网址:www.milinker.com 网店:http://osrc.taobao.com EAT博客:http://blog.chinaaet.com/whilebreak 博客园:http://www.cnblogs.com/milinker/ 2.1 Verilog HDL 代码规范 规范的代码风格,可以让程序更容易阅读和维护. u 文档管理 合理的文档管理也是程序代码规范的重