首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往
您找到你想要的搜索结果了吗?
是的
没有找到

js】如何正确的写代码注释

错误注释 你的注释是不是这样的? //时间戳日期格式化函数 function formTime(time,isyear){ } 亦或者是这样的?...、易维护、易理解,起到提示的作用的,上面的两个注释都是正确的,但是它起到的作用太低了,在正式工作中我们往往会协同开发,这种注释是万万不可的。...正确注释 正确的注释 就是文档注释,先来看看是什么样子。...优点 方法提示 time是个字符串 我们要截取字符串 普通注释 文档注释 内容提示 鼠标移动到函数以及参数上所给的提示。...npm install jsdoc -g 基本使用 jsdoc 文件名 其他的使用方式可以去官网查看 jsdoc 33.js 执行完此命令,会生成一个out文件夹,查看里面的index页面即可,右边侧边栏会显示函数的使用

16820

JS通用模块写法

模块化这个问题并非一开始就存在,WWW 刚刚问世的时候,html,JavaScript,CSS(JS 和 CSS 都是后来在网景被引进浏览器的)都是极其简单的存在,不需要模块化。...在 ES6 以前,JS 语言没有模块化,如何让 JS 不止运行在浏览器,且能更有效的管理代码, 于是应运而生 CommonJS 这种规范,定义了三个全局变量: require,exports,module...require 用于引入一个模块 exports 对外暴露模块的接口,可以是任何类型 module 是这个模块本身的对象 用 require 引入时获取的是这个模块对外暴露的接口(exports) Node.js...我们要实现一个模块,让它既能在 seajs(CMD)环境里引入,又能在 requirejs(AMD)环境中引入,当然也能在 Node.js(CommonJS)中使用,另外还可以在没有模块化的环境中用 script...然后还要满足 script 标签全局引入,我们可以将模块放在 window 上,为了模块内部在浏览器和 Node.js 中都能使用全局对象,我们可以做此判断: var global = typeof window

2K10

CSS模块注释——页面重构中的模块化设计(六)

CSS模块注释——页面重构中的模块化设计(六) 由 Ghostzhang 发表于 2010-07-20 14:07 从前面的内容我们已经知道,样式是可以分成各个模块去写的,如何表示各个模块的作用及它们之间的关系呢...CSS的注释是不二的选择。 与普通的注释不同,模块注释需要一些更详细的内容,比如:功能说明、模块版本、关联信息等等。...像 《基类、扩展类──页面重构中的模块化设计(五)》 中例子的注释,显然是比较简单的。为了减少不必要的沟通,我们可以使用较为固定的格式去完成这个注释。...主要的关键字有: @name标明模块的名称@author标明模块的作者@version标明该模块的版本@explain功能说明@relating标明该关联的模块@dependent标明该所依赖的模块@type...即: @关键字:值* 以“/* @end **/”标记模块的结束 模块注释内不可嵌套 提供了一个小工具( cssModeCode )帮助大家填写样式模块注释

52720

js 模块化发展

1 引言 如今,Javascript 模块化规范非常方便、自然,但这个新规范仅执行了2年,就在 4 年前,js模块化还停留在运行时支持,10 年前,通过后端模版定义、注释定义模块依赖。...注释依赖定义 (2006): 几乎和模版依赖定义同时出现,与 1999 年方案不同的,不仅仅是模块定义方式,而是终于以文件为单位定义模块了,通过 lazyjs 加载文件,同时读取文件注释,继续递归加载剩下的文件...Http 2.0 对 js 模块化的推动 js 模块化定义的再美好,浏览器端的支持粒度永远是瓶颈,http 2.0 正是考虑到了这个因素,大力支持了 ES 2015 模块化规范。...一句话,模块化仍在路上。js 模块化的矛头已经对准了 css 与 html,这两位元老也该向前卫的 js 学习学习了。...未来 css、html 的模块化会自立门户,还是赋予 js 更强的能力,让两者的模块化依附于 js 的能力呢?

2.1K20

js模块化例子

最近在看一本书,里面提到js模块化,觉得很有必要,所以记录下来 Game.js /** * This is the main class that handles the game life cycle..._canvas.height); }; ---- boardRenderer.js /** * 这个类负责绘制,棋盘,球 * @param context the 2d context to draw..._rows; }; ---- boardModel.js /** * 这个类是负责保存/验证/返回当前游戏的状态 * 如当前的玩家是谁、每个单元格放的是什么球、 * 是不是谁赢了 * @param...this.reset(); } /** * 0代表单元格为空,1代表单元格有红色球,2代表单元格有绿色球 * 因为怕以后忘记这些数字代表什么,干脆把数字存到常量里,代码看起来易懂, * 但是这么多字,前端的js...* ps.变量名全大写表示这是常量,这是一个js程序员之间的约定,表达为 CAPITAL_CASED。

4.6K20

JS模块加载框架 SeaJS

,让开发可以专注于代码本身的逻辑 上手示例 html中加载初始化模块init.js,init 中调用 module1 模块,同时 module1 模块调用 module2 模块 ?..., factory) id : 模块标识(选填),不填时,id会被默认赋值为此js文件的绝对路径 deps : 是模块依赖(选填) factory : 模块定义方法(必填) 例如 define...,他有三个参数: 1)require 模块加载函数,用于记载依赖模块 2)exports 接口点,将数据或方法定义在其上则将其暴露给外部调用 3)module 模块的元数据,存储了模块的元信息(module.id...模块的ID、module.dependencies 此模块依赖的所有模块的ID列表、module.exports 与exports指向同一个对象) 模块的寻址 (1)绝对地址——给出js文件的绝对路径...require("http://example/js/a"); (2)相对地址——用载入函数所在js文件的相对地址寻找模块 例如有 js/a.jsjs/m/b.js 在b.js中调用上级级目录下的

6K50

模块化】:JS 模块化极简史

便于依赖管理(无须手动组织JS文件顺序); c. 利于性能优化(异步模块加载); e. 提高可维护性; f. 利于代码复用; 2....传统模块化阶段 这一阶段,WEB 开发人员主要是利用 JS 语言的闭包、原型、函数作用域等特性,减少对全局命名空间的污染;方式方法各有不同,但结果都差不多,比较混乱... 3.1....CommonJS是针对服务器端(非浏览器环境)的JavaScript开发,是Node.js的默认模块化规范; (2)....import): 总结一下 传统模块化手段:通过JS的闭包、对象、自执行函数等语言特性,避免模块间的命名冲突,提高模块的内聚性,但无统一编程标准,也无法把模块间的依赖关系描述清晰; CommonJS...:Node.js让JavaScript延伸到“服务端”领域,促使针对“服务端”的JavaScript静态模块化规范CommonJS诞生,但此规范的“同步阻塞式”模块加载策略不适用于浏览器端环境; AMD

1.9K10
领券