代码整洁之道(二)优雅注释之道

  1. 云栖社区>
  2. 弹性计算>
  3. 博客>
  4. 正文

代码整洁之道(二)优雅注释之道

竹涧 2018-06-21 15:21:12 浏览3619
展开阅读全文

一、Best Practice

注释应该声明代码的高层次意图,而非明显的细节

反例

    /**
     * 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
     * @retur

网友评论

登录后评论
0/500
评论
竹涧
+ 关注
所属云栖号: 弹性计算