zoukankan      html  css  js  c++  java
  • 构建之法阅读笔记02

          我过去自己在写代码时,无论是大型程序还是小型的程序,很少写注释,主要是因为自己觉得很麻烦,既然是自己写出来的代码,自己本来就会,写什么注释啊~~~过了一段时间之后,有人问自己某道题怎么做时,自己会把曾经写过的代码拿出来给他看,但是他根本看不懂。当自己重新看一遍时,有时也忘记了曾经是怎么想的。还需要好长时间去重新分析;

          看了本书第4章《代码规范》部分后,发现了代码规范很重要。这里我想强调下注释的重要性!如果不加注释,对他人,对自己都是对时间的一种浪费!而且不光要注释,还要知道怎么写注释!

          解决办法:

       1.不要注释程序是怎么工作的(how),注释是为了解释程序是做什么的(what),为什么这样做(why),以及要特别注意的地方。

       2.复杂的注释应该放在函数头

       3.注释也要随着程序的修改而不断地更新

       4.注释包括所有源代码应该只用ASCII字符,不要用中文或其他特殊字符,否则会极大影响程序的可移植性。

  • 相关阅读:
    Beta 冲刺(1/7)
    福大软工 · 第十次作业
    福大软工 · BETA 版冲刺前准备(团队)
    福大软工 · 第十一次作业
    Alpha 冲刺 (10/10)
    Alpha 冲刺 (9/10)
    Alpha 冲刺 (8/10)
    vue 写一个瀑布流插件
    微信小程序页面滚动到指定位置
    写一个vue的滚动条插件
  • 原文地址:https://www.cnblogs.com/X-knight/p/5259170.html
Copyright © 2011-2022 走看看