代码整洁之道(二)优雅注释之道
一、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