一、Best Practice注释应该声明代码的高层次意图，而非明显的细节反例 说明上文方法用于根据参数生成签名，注释中详细描述了签名算法的实现步骤，这其实就是过度描述代码明显细节正例 总结1. 注释一定是表达代码之外的东西，代码可以包含的内容，注释中一定不要出现2. 如果有必要注释，请注释意图（why），而不要去注释实现（how)，大家都会看代码在文件/类级别使用全局注释来解释所有部分如何工作正例 总结通常每个文件或类都应该有一个全局注释来概述该类的作用公共api需要添加注释，其它代码谨慎使用注释反例 说明以上接口提供dubbo rpc服务属于公共api，以二方包的方式提供给调用方，虽然代码简单缺少了接口概要描述及方法注释等基本信息。正例 总结公共api一定要有注释，类文件使用类注释，公共...阅读全文
前言 本规范的目的是为了统一项目的编码风格，提高软件源程序的可读性、可靠性和可重用性，提高软件源程序的质量和可维护性，减少软件维护成本，最终提高软件产品生产力。本规范是针对 Golang 语言的编码规范，其它不同编程语言可以参照此规范执行。本规范适用于部门所有产品的软件源程序，同时考虑到不同产品和项目的实际开发特性，本规范分成规则性和建议性两种：对于规则性规范，要求所有软件开发人员严格执行；对于建议性规范，各项目编程人员可以根据实际情况选择执行。本规范的示例都以 Golang 语言描述。本规范的内容包括：开发环境、包设计、布局、注释、命名、基本元素设计、函数设计、错误和异常设计、整洁测试等。本规范自生效日起，对以后新编写的和修改的代码有约束力。对本规范中所用的术语解释如下：原则：编程时应该坚...阅读全文
1. 尽早返回 反例: //UserCtrl func UserInfo(userId string){ user.UserInfo(userId) .... .... //resp result ... } //UserService func UserInfo(userId string){ if len(userId) > 0 { //do query database ..... } } // repo func queryUserInfo(userId string){ if len(userId) > 0{ //select * from user where user_id = ? } } 从这个例子来看，在service层和数据库查询，我们都进行了userId的判断. 因为当...阅读全文
最佳实践 1. 注释应该声明代码的高层次意图，而非明显的细节 反例 /** * generate signature by code, the algorithm is as follows: * 1.sort the http params, if you use java, you can easily use treeMap data structure * 2.join the param k-v * 3.use hmac-sha1 encrypt the specified string * * @param params request params * @param secret auth secret * @return secret sign * @throws Excep...阅读全文
go 语言规范里定义的 method sets 规则 Values 可调用的方法（methods receivers） 备注 T (t T) funcXXX 为什么不能调用 (t *T) funcXXX，因为无法保证所有的Value 都可以获取到指针地址(addressable value) *T (t T) funcXXX and (t *T) funcXXX go 自动转化(dereferenced) *T --> T, 所以可以调用 为什么有些值无法获取地址？ go spec: https://golang.org/ref/spec#Address_operators 说明了不能寻址的情况。 常见的不能寻址的情况： &m["key"] &afunc() &t.method() var ...阅读全文
