代码审计(规范)

代码规范性

  • 不要重复自己的(Don't Repeat Yourself)
  • 必要的注释
/** 
  * Compute the hailstone sequence.
  * See http://en.wikipedia.org/wiki/ Collatz_conjecture#Statement_of_the_problem
  * @param n starting number of sequence; requires n > 0.
  * @return the hailstone sequence starting at n and ending with 1.
  *         
  * For example, hailstone(3)=[3,10,5,16,8,4,2,1].
    */
    public static List<Integer> hailstoneSequence(int n) {
    ...
    }
  • 程序bug尽早暴露(Fail Fast)
  • 避免魔数(如Math.sin(“30”))
  • 每个变量只有一个用途
  • 使用好的变量名
  • 不要使用全局变量
  • 使用空格让程序可读性好
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

友情链接更多精彩内容