在命名规范的情况 你还会写注释么？

Question

比如一些方法// 封装链路信息数据formatLinksInfo() {}// 获取节点坐标数据getNodesPosition() {}// ip转数字ipToNum() {}// 判断元素是否全部选中isAllElemsActive() {}// 右键菜单选项itemContextMenu() {}if(target.classed('topo')){} // 拓扑图情况if(target.classed('node')){} // 节点if(target.classed('link')){} // 链路比如像这种命名 不写注释感觉也能通过方法名或者类名 也能看懂，但自己还是都写了 现在code review看来觉得很冗余问一下你们关于代码注释编写原则是啥呢，能通过命名读懂的都不写么？

Answer 1

• 你不应该在每次调用方法的时候写注释，而是应该在声明函数的地方写注释

• 建议每个函数都写相应的注释

• 你自己写代码存在主观性，你觉得规范，其实不一定规范，或许可以说不一定全面;

• 每个人理解方法是不一样的，你觉得命名规范了，那也许是真的很规范，但是并不是所有人都能一下子看懂，如果要整个遍历一下方法实现过程这是非常浪费时间的，别人看到一个函数应该立刻能从注释和方法名知道这个函数是干什么的;

• 函数名写的再好，我也只能大概猜到这个函数是干什么的，但是我对函数的参数和返回值类型等信息一无所知

• 总而言之，空间换时间，一次时间换以后的N次时间是非常值得的

• 建议写英文注释，这样review起来更加简洁，不显得那么格格不入，不要觉得什么自己或者其他人英文底子不好，网上各种英汉词典，多写英文注释遇到不知道的还能多学几个英文单词