JavaScript 注释规范 总原则 As short as possible(如无必要,勿增注释).尽量提高代码本身的清晰性.可读性. As long as necessary(如有必要,尽量详尽).合理的注释.空行排版等,可以让代码更易阅读.更具美感. 总之,注释的目的是:提高代码的可读性,从而提高代码的可维护性. 什么时候需要添加注释 某段代码的写法,需要注释说明 why 时: // Using loop is more efficient than `rest = slice.call
RESTful API 编写规范 在一个RESTful系统里,客户端向服务端发起索取资源的操作只能通过HTTP协议语义来进行交互.最常用的HTTP协议语义有以下5个: GET GET:发送一条或者多条GET请求都不会改变服务器里面的资源,同一个request发一遍和发两遍都将获得相同结果.这个交互行为是幂等的. GET:从服务器取出资源(一项或多项) @ApiOperation(value="获取用户列表", notes="") @RequestMapping(va