简介

  • 3 分钟

你编写的代码应向编译器和可能需要阅读你代码的其他开发人员传达你的意图。 而且，由于你自己是最常阅读你的代码的开发人员，有时会在最初编写代码后的几个月内进行阅读，因此，编写清晰易懂的代码符合你的最佳利益。 请记住，你可能只编写一次代码，但你需要读上许多遍。

假设你被要求为另一组开发人员编写一些代码。 你与他们会面讨论规范，明确任务分配。 会议结束后，他们告诉你，你将在开发过程中独立工作。 完成后，你将代码移交给其他组。 编码任务并不超出你的技能水平，但你不必编写其他人将维护的代码。 团队告诉你，只要你遵循 C# 的标准编码约定，就应该没有问题。 你制定计划来查看与要处理的代码相关的 C# 编码约定。

在本模块中，你将了解如何为变量选择一个描述其目的和意图的名称。 你将了解如何添加代码注释，以便在代码中记录大概要求和你的方法，以及暂时指示编译器忽略代码行。 最后，你将学习如何使用空格来帮助传达各代码行之间的关系。

学完本模块后，你将能够更有目的地编写代码，注重代码的可读性和质量以向编译器和其他开发者传达信息。

重要

此模块包含需要 Visual Studio Code 的编码活动。 你需要访问已安装并配置 Visual Studio Code 的开发环境，以进行 C# 应用程序开发。

学习目标

在本模块中，你将：

  • 为变量选择一个描述其目的和意图的描述性名称。
  • 使用代码注释暂时指示编译器忽略代码行。
  • 使用代码注释描述一段代码的更高级别要求或用途。
  • 编写有效使用空格来传达代码行之间关系的代码。

先决条件

  • 具备使用 Visual Studio Code 创建和运行 C# 控制台应用程序的经验。
  • 具备使用 Console.WriteLine() 将消息打印到控制台的经验。
  • 具备使用 if 和 else if 语句创建代码分支的经验。