前端开发规范(四、JS篇)( 五 )
As long as necessary（如有必要 ， 尽量详尽）：合理的注释、空行排版等 ， 可以让代码更易阅读、更具美感 。
单行注释
必须独占一行 。 // 后跟一个空格 ， 缩进与下一行被注释说明的代码一致 。
多行注释
避免使用 /…/ 这样的多行注释 。 有多行注释内容时 ， 使用多个单行注释 。
函数/方法注释
函数/方法注释必须包含函数说明 ， 有参数和返回值时必须使用注释标识 。 ；
参数和返回值注释必须包含类型信息和说明；
当函数是内部函数 ， 外部不可访问时 ， 可以使用 @inner 标识；
文件注释
文件注释用于告诉不熟悉这段代码的读者这个文件中包含哪些东西 。 应该提供文件的大体内容 它的作者 依赖关系和兼容性信息 。 如下:
推荐阅读
- 魔兽世界|《轨迹》新作明年发布! 法老控将针对NS平台开发游戏
- 手机游戏|CFHD：神秘组织为什么开发生化手雷呢？关键是为了赚更多钱
- 大话西游|大话西游2这些召唤兽的天生技能是开发组拿来凑数的吗？实际效果完全没用
- 电子竞技|【欣然轻资讯G】《地平线2西部禁域》新老怪兽即将登场 开发者日志
- 桌游|48小时里，游戏开发能给这群大学生带来什么？
- 任天堂|不依赖对外收购工作室，任天堂将更着重扩大本身游戏内容开发能力
- 网游|《红色警戒2》超大Mod“心灵终结”发布3.3.6版，15年的开发完结
- 腾讯|3A 开放世界新作《王者荣耀：世界》公开，由腾讯天美工作室开发
- |不朽情缘五滴血必爆大奖技巧
- 炉石传说|炉石传说狂野奇数猎打不过？国服大神开发出一套奇数德，稳吃