用计算机编程
为孩子赋能

编程过程中的注释

编程过程中的注释

引子 — 为什么要引入注释?

  • 经常会忘记自己的代码的意图和思路, 导致需要浪费额外的时间去重新理解自己写的代码
  • 协作时,或者后期修改时,很难理解他人的意图

意识

注释是为了方便自己和团队的同伴, 而不是用来帮助计算机.
注释是给自己和同伴看的,不是给程序执行的, 注释的内容不会被程序解读显示.

注释的派生应用

把某一部分代码注释掉, 临时跳过程序中的某些部分, 从而用来测试调错.

注释的风格

分为2大类:

  • Unix Shell 注释风格
    • 单行 # (Shell 没有标记多行注释的字符, 只能是一行一行老老实实写 #)
  • C 注释风格
    • 单行 // (准确的说, 这是C++的注释风格)
    • 多行 /* */

各编程语言的注释方法

需求 HTML CSS Python JavaScript PHP SQL
单行注释和行末注释 <!--注释内容--> /*注释内容*/ # 注释内容 // 注释内容 // --注释内容
多行注释 <!--注释内容--> /*注释内容*/ # 注释内容或者'''注释内容''' /* 注释内容 */ /* 注释内容 */ /* 注释内容 */

记忆要点:

  • HTML和CSS和Python的单行和多行注释是相同的
    • HTML是<!--注释内容-->
    • CSS是/*注释内容*/
    • Python是# 注释内容, 同时Python使用”三重引号字符”'''注释内容'''
  • JavaScript和SQL的单行和多行注释是不同的
  • JavaScript和PHP的单行和多行注释是一样的
  • CSS, JavaScript和SQL的多行注释是相同的, 都是/* 注释内容 */, 注意, Python没有这种注释
  • Python的”三重引号字符”原来的作用是界定跨行的字符串. 因为没有”变量名”,程序不会对字符串处理,所以可以被用于注释; 但不推荐作为”注释”使用, 因为不显眼; 同时, 因为比#注释方便, 推荐临时使用于让部分代码暂时不被执行;

文章历史

  • 2016/10/22 (在简书发布)
赞(0)

评论 抢沙发

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址