百度公司的内部编码规范和我本学期需要遵守的编程规范

软工2201蔡奕杨 2022级 2023-09-10 18:33:17

读《数学之美》第十四章有感

      《数学之美》是一本令人着迷的书,其中一章“余弦定理和新闻的分类”探讨了数学在解决实际问题中的应用,以及如何利用数学原理来处理信息。这一章节引人入胜,让我深刻认识到数学不仅仅是一门抽象的学科,还可以为我们解决日常生活中的问题提供有力工具。
       通过阅读这一章,我意识到数学的力量不仅仅体现在学术研究中,还可以直接应用于解决实际问题。余弦定理和降维技术等数学工具可以帮助我们更好地理解和利用大量的信息,从而推动科学、商业和社会的发展。这个章节激发了我对数学在解决现实世界难题中的无限潜力的兴趣,并使我更加珍视数学的重要性。
总的来说,读完《数学之美》中的“余弦定理和新闻的分类”这一章,我对数学的认识得到了深化,也更加明白了数学在解决实际问题中的实际应用。这本书为我打开了一扇通向数学与现实世界紧密联系的大门,让我更加欣赏数学在塑造我们生活的方方面面中所起的关键作用。

 

目录

1 代码风格

1.1 文件

1.2 结构

1.3 命名

1.4 注释

2 语言特性

2.1 变量

2.2 条件

2.3 循环

2.4 类型

2.5 字符串

2.6 对象

2.7 数组

2.8 函数

2.9 面向对象

2.10 动态特性

3 浏览器环境

3.1 模块化

3.2 DOM

         4 我本学期遵循的编程规范


1 代码风格

1.1 文件

[建议] JavaScript 文件使用无 BOM 的 UTF-8 编码。

[建议] 在文件结尾处,保留一个空行。

1.2 结构

1.2.1 缩进

[强制] 使用 4 个空格做为一个缩进层级,不允许使用 2 个空格 或 tab 字符。

[强制] switch 下的 case 和 default 必须增加一个缩进层级。

1.2.2 空格

[强制] 二元运算符两侧必须有一个空格,一元运算符与操作对象之间不允许有空格。

[强制] 用作代码块起始的左花括号 { 前必须有一个空格。

[强制] if / else / for / while / function / switch / do / try / catch / finally 关键字后,必须有一个空格。

[强制] 在对象创建时,属性中的 : 之后必须有空格,: 之前不允许有空格。

[强制] 函数声明、具名函数表达式、函数调用中,函数名和 ( 之间不允许有空格。

[强制] , 和 ; 前不允许有空格。如果不位于行尾,, 和 ; 后必须跟一个空格。

[强制] 在函数调用、函数声明、括号表达式、属性访问、if / for / while / switch / catch 等语句中,() 和 [] 内紧贴括号部分不允许有空格。

[强制] 单行声明的数组与对象,如果包含元素,{} 和 [] 内紧贴括号部分不允许包含空格。

[强制] 行尾不得有多余的空格。

1.2.3 换行

[强制] 每个独立语句结束后必须换行。

[强制] 每行不得超过 120 个字符。

[强制] 运算符处换行时,运算符必须在新行的行首。

[强制] 在函数声明、函数表达式、函数调用、对象创建、数组创建、for 语句等场景中,不允许在 , 或 ; 前换行。

[建议] 不同行为或逻辑的语句集,使用空行隔开,更易阅读。

[建议] 在语句的行长度超过 120 时,根据逻辑条件合理缩进。

[建议] 对于 if...else...try...catch...finally 等语句,推荐使用在 } 号后添加一个换行 的风格,使代码层次结构更清晰,阅读性更好。

1.2.4 语句

[强制] 不得省略语句结束的分号。

[强制] 在 if / else / for / do / while 语句中,即使只有一行,也不得省略块 {...}

[强制] 函数定义结束不允许添加分号。

[强制] IIFE 必须在函数表达式外添加 (,非 IIFE 不得在函数表达式外添加 (

1.3 命名

[强制] 变量 使用 Camel命名法

[强制] 常量 使用 全部字母大写,单词间下划线分隔 的命名方式。

[强制] 函数 使用 Camel命名法

[强制]  使用 Pascal命名法

[强制] 函数的 参数 使用 Camel命名法

[强制] 类的 方法 / 属性 使用 Camel命名法

[强制] 枚举变量 使用 Pascal命名法枚举的属性 使用 全部字母大写,单词间下划线分隔 的命名方式。

[强制] 命名空间 使用 Camel命名法

[强制] 由多个单词组成的缩写词,在命名中,根据当前命名法和出现的位置,所有字母的大小写与首字母的大小写保持一致。

[强制] 类名 使用 名词

[建议] 函数名 使用 动宾短语

[建议] boolean 类型的变量使用 is 或 has 开头。

[建议] Promise对象 用 动宾短语的进行时 表达。

1.4 注释

1.4.1 单行注释

[强制] 必须独占一行。// 后跟一个空格,缩进与下一行被注释说明的代码一致。

1.4.2 多行注释

[建议] 避免使用 /*...*/ 这样的多行注释。有多行注释内容时,使用多个单行注释。

1.4.3 文档化注释

[强制] 为了便于代码阅读和自文档化,以下内容必须包含以 /**...*/ 形式的块注释中。

[强制] 文档注释前必须空一行。

[建议] 自文档化的文档说明 what,而不是 how。

1.4.4 类型定义

[强制] 类型定义都是以 { 开始, 以 } 结束。

[强制] 对于基本类型 {string}, {number}, {boolean},首字母必须小写。

1.4.5 文件注释

[强制] 文件顶部必须包含文件注释,用 @file 标识文件说明。

[建议] 文件注释中可以用 @author 标识开发者信息。

1.4.6 命名空间注释

[建议] 命名空间使用 @namespace 标识。

1.4.7 类注释

[建议] 使用 @class 标记类或构造函数。

[建议] 使用 @extends 标记类的继承信息。

[强制] 使用包装方式扩展类成员时, 必须通过 @lends 进行重新指向。

[强制] 类的属性或方法等成员信息不是 public 的,应使用 @protected 或 @private 标识可访问性。

1.4.8 函数/方法注释

[强制] 函数/方法注释必须包含函数说明,有参数和返回值时必须使用注释标识。

[强制] 参数和返回值注释必须包含类型信息,且不允许省略参数的说明。

[建议] 当函数是内部函数,外部不可访问时,可以使用 @inner 标识。

[强制] 对 Object 中各项的描述, 必须使用 @param 标识。

[建议] 重写父类方法时, 应当添加 @override 标识。如果重写的形参个数、类型、顺序和返回值类型均未发生变化,可省略 @param@return,仅用 @override 标识,否则仍应作完整注释。

1.4.9 事件注释

[强制] 必须使用 @event 标识事件,事件参数的标识与方法描述的参数标识相同。

[强制] 在会广播事件的函数前使用 @fires 标识广播的事件,在广播事件代码前使用 @event 标识事件。

[建议] 对于事件对象的注释,使用 @param 标识,生成文档时可读性更好。

1.4.10 常量注释

[强制] 常量必须使用 @const 标记,并包含说明和类型信息。

1.4.11 复杂类型注释

[建议] 对于类型未定义的复杂结构的注释,可以使用 @typedef 标识来定义。

1.4.12 AMD 模块注释

[强制] AMD 模块使用 @module 或 @exports 标识。

[强制] 对于已使用 @module 标识为 AMD模块 的引用,在 namepaths 中必须增加 module: 作前缀。

[建议] 对于类定义的模块,可以使用 @alias 标识构建函数。

[建议] 多模块定义时,可以使用 @exports 标识各个模块。

[建议] 对于 exports 为 Object 的模块,可以使用@namespace标识。

[建议] 对于 exports 为类名的模块,使用 @class 和 @exports 标识。

1.4.13 细节注释

[建议] 细节注释遵循单行注释的格式。说明必须换行时,每行是一个单行注释的起始。

[强制] 有时我们会使用一些特殊标记进行说明。特殊标记必须使用单行注释的形式。下面列举了一些常用标记:

2 语言特性

2.1 变量

[强制] 变量、函数在使用前必须先定义。

[强制] 每个 var 只能声明一个变量。

[强制] 变量必须 即用即声明,不得在函数或其它形式的代码块起始位置统一声明所有变量。

2.2 条件

[强制] 在 Equality Expression 中使用类型严格的 ===。仅当判断 null 或 undefined 时,允许使用 == null

[建议] 尽可能使用简洁的表达式。

[建议] 按执行频率排列分支的顺序。

[建议] 对于相同变量或表达式的多值条件,用 switch 代替 if

[建议] 如果函数或全局中的 else 块后没有任何语句,可以删除 else

2.3 循环

[建议] 不要在循环体中包含函数表达式,事先将函数提取到循环体外。

[建议] 对循环内多次使用的不变值,在循环外用变量缓存。

[建议] 对有序集合进行遍历时,缓存 length

[建议] 对有序集合进行顺序无关的遍历时,使用逆序遍历。

2.4 类型

2.4.1 类型检测

[建议] 类型检测优先使用 typeof。对象类型检测使用 instanceofnull 或 undefined 的检测使用 == null

2.4.2 类型转换

[建议] 转换成 string 时,使用 + ''

[建议] 转换成 number 时,通常使用 +

[建议] string 转换成 number,要转换的字符串结尾包含非数字并期望忽略时,使用 parseInt

[强制] 使用 parseInt 时,必须指定进制。

[建议] 转换成 boolean 时,使用 !!

[建议] number 去除小数点,使用 Math.floor / Math.round / Math.ceil,不使用 parseInt

2.5 字符串

[强制] 字符串开头和结束使用单引号 '

[建议] 使用 数组 或 + 拼接字符串。

[建议] 使用字符串拼接的方式生成HTML,需要根据语境进行合理的转义。

[建议] 复杂的数据到视图字符串的转换过程,选用一种模板引擎。

2.6 对象

[强制] 使用对象字面量 {} 创建新 Object

[建议] 对象创建时,如果一个对象的所有 属性 均可以不添加引号,建议所有 属性 不添加引号。

[建议] 对象创建时,如果任何一个 属性 需要添加引号,则所有 属性 建议添加 '

[强制] 不允许修改和扩展任何原生对象和宿主对象的原型。

[建议] 属性访问时,尽量使用 .

[建议] for in 遍历对象时, 使用 hasOwnProperty 过滤掉原型中的属性。

2.7 数组

[强制] 使用数组字面量 [] 创建新数组,除非想要创建的是指定长度的数组。

[强制] 遍历数组不使用 for in

[建议] 不因为性能的原因自己实现数组排序功能,尽量使用数组的 sort 方法。

[建议] 清空数组使用 .length = 0

2.8 函数

2.8.1 函数长度

[建议] 一个函数的长度控制在 50 行以内。

2.8.2 参数设计

[建议] 一个函数的参数控制在 6 个以内。

[建议] 通过 options 参数传递非数据输入型参数。

2.8.3 闭包

[建议] 在适当的时候将闭包内大对象置为 null

[建议] 使用 IIFE 避免 Lift 效应

2.8.4 空函数

[建议] 空函数不使用 new Function() 的形式。

[建议] 对于性能有高要求的场合,建议存在一个空函数的常量,供多处使用共享。

2.9 面向对象

[强制] 类的继承方案,实现时需要修正 constructor

[建议] 声明类时,保证 constructor 的正确性。

[建议] 属性在构造函数中声明,方法在原型中声明。

[强制] 自定义事件的 事件名 必须全小写。

[强制] 自定义事件只能有一个 event 参数。如果事件需要传递较多信息,应仔细设计事件对象。

[建议] 设计自定义事件时,应考虑禁止默认行为。

2.10 动态特性

2.10.1 eval

[强制] 避免使用直接 eval 函数。

[建议] 尽量避免使用 eval 函数。

2.10.2 动态执行代码

[建议] 使用 new Function 执行动态代码。

2.10.3 with

[建议] 尽量不要使用 with

2.10.4 delete

[建议] 减少 delete 的使用。

[建议] 处理 delete 可能产生的异常。

2.10.5 对象属性

[建议] 避免修改外部传入的对象。

[建议] 具备强类型的设计。

3 浏览器环境

3.1 模块化

3.1.1 AMD

[强制] 使用 AMD 作为模块定义。

[强制] 模块 id 必须符合标准。

3.1.2 define

[建议] 定义模块时不要指明 id 和 dependencies

[建议] 使用 return 来返回模块定义。

3.1.3 require

[强制] 全局运行环境中,require 必须以 async require 形式调用。

[强制] 模块定义中只允许使用 local require,不允许使用 global require

[建议] 不会被调用的依赖模块,在 factory 开始处统一 require

3.2 DOM

3.2.1 元素获取

[建议] 对于单个元素,尽可能使用 document.getElementById 获取,避免使用document.all

[建议] 对于多个元素的集合,尽可能使用 context.getElementsByTagName 获取。其中 context 可以为 document 或其他元素。指定 tagName 参数为 * 可以获得所有子元素。

[建议] 遍历元素集合时,尽量缓存集合长度。如需多次操作同一集合,则应将集合转为数组。

[建议] 获取元素的直接子元素时使用 children。避免使用childNodes,除非预期是需要包含文本、注释和属性类型的节点。

3.2.2 样式获取

[建议] 获取元素实际样式信息时,应使用 getComputedStyle 或 currentStyle

3.2.3 样式设置

[建议] 尽可能通过为元素添加预定义的 className 来改变元素样式,避免直接操作 style 设置。

[强制] 通过 style 对象设置元素样式时,对于带单位非 0 值的属性,不允许省略单位。

3.2.4 DOM 操作

[建议] 操作 DOM 时,尽量减少页面 reflow

[建议] 尽量减少 DOM 操作。

3.2.5 DOM 事件

[建议] 优先使用 addEventListener / attachEvent 绑定事件,避免直接在 HTML 属性中或 DOM 的 expando 属性绑定事件处理。

[建议] 使用 addEventListener 时第三个参数使用 false

[建议] 在没有事件自动管理的框架支持下,应持有监听器函数的引用,在适当时候(元素释放、页面卸载等)移除添加的监听器。

4 我本学期遵循的编程规范

4.1 使用 4 个空格做为一个缩进层级,不允许使用 2 个空格 或 tab 字符。

4.2  二元运算符两侧必须有一个空格,一元运算符与操作对象之间不允许有空格。

4.3 if / else / for / while / function / switch / do / try / catch / finally 关键字后,必须有一个空格。

4.4 每个独立语句结束后必须换行。

4.5 运算符处换行时,运算符必须在新行的行首。

4.6 在函数声明、函数表达式、函数调用、对象创建、数组创建、for 语句等场景中,不允许在 , 或 ; 前换行。

4.7 不得省略语句结束的分号。

4.8  在 if / else / for / do / while 语句中,即使只有一行,也不得省略块 {...}

4.9 变量 使用 Camel命名法

4.10 由多个单词组成的缩写词,在命名中,根据当前命名法和出现的位置,所有字母的大小写与首字母的大小写保持一致。

...全文
31 1 打赏 收藏 转发到动态 举报
写回复
用AI写文章
1 条回复
切换为时间正序
请发表友善的回复…
发表回复
软工2201蔡奕杨 2022级 2023-10-25
  • 打赏
  • 举报
回复

读数学之美第十四章有感
《数学之美》是一本令人着迷的书,其中一章“余弦定理和新闻的分类”探讨了数学在解决实际问题中的应用,以及如何利用数学原理来处理信息。这一章节引人入胜,让我深刻认识到数学不仅仅是一门抽象的学科,还可以为我们解决日常生活中的问题提供有力工具。
通过阅读这一章,我意识到数学的力量不仅仅体现在学术研究中,还可以直接应用于解决实际问题。余弦定理和降维技术等数学工具可以帮助我们更好地理解和利用大量的信息,从而推动科学、商业和社会的发展。这个章节激发了我对数学在解决现实世界难题中的无限潜力的兴趣,并使我更加珍视数学的重要性。
总的来说,读完《数学之美》中的“余弦定理和新闻的分类”这一章,我对数学的认识得到了深化,也更加明白了数学在解决实际问题中的实际应用。这本书为我打开了一扇通向数学与现实世界紧密联系的大门,让我更加欣赏数学在塑造我们生活的方方面面中所起的关键作用。

273

社区成员

发帖
与我相关
我的任务
社区描述
广东外语外贸大学信息科学与技术学院
算法 高校
社区管理员
  • brisksea
加入社区
  • 近7日
  • 近30日
  • 至今
社区公告
暂无公告

试试用AI创作助手写篇文章吧