课堂评论：在教学中使用评论中的评论小小书 XXshu

文本被注释。从插图到哲学思考，旧手稿经常带有边缘特征。如果您不写书，您可能会认识一个人。英语教授鼓励重点和重点。甚至电子阅读器也包括书签，笔记和以其他方式提供数字文本个人评论的方法。

在使用代码作为课程一部分的课程中，老师和学生都可以利用大多数编程语言中的一项功能：注释。注释是被键入为自然人类语音的单词和短语，与编写供计算机解析的代码一起显示。他们可以给出指令，帮助程序员“调试”过时的代码，或者充当发泄的场所。

什么是评论？

注释是计算机在运行程序时忽略的文本位。根据编程语言的不同，注释通常会显示在编码环境中，而不显示在最终产品中。例如，HTML用于构建网站，并且标记语言可以在文本编辑器或集成开发环境（IDE）中注释掉。这些评论不会在加载到浏览器中的页面上显示。相反，通常只能通过导航到“查看页面源代码”或类似的位置来通过源代码查看它们。

大多数编程语言都具有某种注释文本的方式，尽管如何添加注释的细节因语言而异。注释语法通常使用连字符，星号和斜杠的组合。例如，在Wolfram语言中，可以通过以下方式将注释添加到笔记本中：用星号将键入的文本括起来，然后将注释括在括号中： （*类似。*）

无论采用哪种语法，注释代码都是通过计算机解析的代码共享人类可读文本的方式，尽管这样做的原因各不相同。例如，学生可能出于与老师不同的原因注释掉代码。尽管代码注释不是必需的 ，并且实际上可以减慢某些编程语言的编译速度，但是它们也可以是有价值的教学实践。

那么，为什么要打扰评论呢？

在某种程度上，注释类似于旁注：它们会添加到原始文本中，而不会占用已有内容。使用所有编程语言，都将对代码进行处理以显示结果，无论是数学计算还是网站的骨骼。这些“边注”位于代码之上，而不会影响最终产品。

注释代码在有目的地使用时，是良好文档和良好沟通的基础。在专业开发领域，注释可以改善共享相同文件的程序员之间的工作流程，从而使每个程序员都能解释自己的代码。这些注释甚至可以充当外部文档的初始种子，并与最终用户共享。

评论不仅在办公室有价值。回到边缘注释的想法，尽管注释可以使好学的读者受益，但从耶鲁大学概述的PDF中也可以看出作者的思想。丢入草稿中的可移动的小杂物可帮助为作者提供上下文。他们可以回答诸如“我为什么要写这个？”或“为什么要为此步骤打扰？”之类的问题，所以它们还可以充当脚注或路标。

学习者可以通过教别人，巩固他们对新学到的事实的长期知识，特别是在点对点教学中。总结章节，编写带注释的书目，撰写博客文章-这些任务中的每一个都具有元认知的各个方面。反思是内部化新信息的重要组成部分，评论可以帮助促进这一过程。

但是，注释不限于笔记或摘要。他们可以进一步向外部读者解释任务，为一系列用例提供更多信息。它们可以充当记忆的辅助工具，使作者可以在解决问题时记住他们的思维过程。它们对于从事计算思想的人员（以解释性和探索性行为）也特别方便。

使用注释代码的方法

Wikipedia上有关代码注释的页面共享了注释代码的多种可能用法，其中许多可以轻松过渡到课堂。例如，当程序员尝试构建自己的算法或代码过程时，他们可以仔细考虑“伪代码”中的规则。伪代码是一种简化计算思想的方式，而无需过多地考虑编程语言的特定语法。对于仅学习如何将任务分解为各个组成部分的学生而言，这是任何终身学习者的一项至关重要的技能，放弃语法可能会突破最初的障碍，从而为复杂的思考留出更多时间。

这些项目本身可以用作计算论文，与叙述线程共享事实和数据。根据注释的嵌入方式，注释可以以与共享信息协同作用的方式解释内容。例如，在“正确”解决方案之前共享一些代码的事后评论的注释日志可提供对学生解决问题技能的更多了解。

Wikipedia页面上提到的另一个用途是提供元数据。对于那些在数字人文项目中使用代码的人，可以在笔记本或其他共享文件中包含属性，以便跟踪资源并提供有用的书目。尽管有很多方法可以在笔记本之外跟踪研究数据-诸如Zotero或Evernote之类的工具，但是有时“在笔记本自身的空白处”书写很有帮助。当然，取决于项目和所使用的编程语言，包括元数据可能是一种好习惯。

在课堂上使用评论

课堂代码中有三种主要的注释用例：

从老师到学生 ，带注释的代码提供了附加说明，作为共享笔记本的一部分。对于某些在线编码课程，注释代码可能是学生的起点，这为他们提供了学习新功能或新技能的支架。
从学生到老师 ，带注释的代码用作反思或解释的手段。如果将文件退还给教师，则该文件中的注释代码可以解释为什么编写代码，而不仅仅是代码本身。
从学生到自我 ，注释的代码要么是伪代码，以快速启动计算思考（先执行，然后执行，然后循环执行，否则…… ）或以后做笔记，以使容易犯错的思想不会失去思路。

这些想法可以进一步混合和匹配。例如，当学生解决问题时，他们可以在课堂代码上发表评论，记录他们的代码迭代记录，并指出哪些有效，哪些无效。这些注释不仅可以为初学者提供见识，供学生以后阅读，还可以与老师共享他们的注释代码，不仅可以提供问题解决方案，还可以提供学生寻找这些结果的方式–一种自然的，内联的“展示方式”他们的工作。”

将注释作为代码练习的一部分可能会在今年的课程中尝试，甚至在您进行自学时也可以尝试。反思性学习，计算思维和技术交流都是非常有用的技能，而与纪律无关，并且超越外部笔记的范围内嵌注释可以帮助促进增长。由于注释的实现非常简单，因此它是对基于代码的课程的快速便捷的补充。

关于博客：

杰西卡·布鲁克斯（Jesika Brooks）

Jesika Brooks是一名编辑兼书虫，拥有图书馆和信息科学硕士学位。她在高等教育领域担任教育技术图书馆馆员，从建立学习管理系统到教学生如何使用edtech工具等一切事务，均提供协助。她本人是一个终身学习者，一直对教育和技术的融合着迷。她编辑了基于技术的教学博客（并且一直希望听到新声音！）。