1.5 Program Documentation 程序文档

Developers create and innovate using an iterative design process that is user-focused, that incorporates implementation/feedback cycles, and that leaves ample room for experimentation and risk-taking.

• 开发者使用以用户为中心的迭代设计过程进行创造和创新，该过程包含实施/反馈循环，并为实验和风险承担留有充足空间。

核心要点 Core Points

1. Program documentation is a written description of the function of a code segment, event, procedure, or program and how it was developed.

   • 程序文档是对代码段、事件、过程或程序功能的书面描述以及它是如何开发的。

2. Comments are a form of program documentation written into the program to be read by people and do not affect how a program runs.

   • 注释是写入程序中供人们阅读的程序文档形式，不会影响程序的运行方式。

3. Programmers should document a program throughout its development.

   • 程序员应该在程序的整个开发过程中记录文档。

4. Program documentation helps in developing and maintaining correct programs when working individually or in collaborative programming environments.

   • 程序文档有助于在单独工作或在协作编程环境中开发和维护正确的程序。

5. Not all programming environments support comments, so other methods of documentation may be required.

   • 并非所有编程环境都支持注释，因此可能需要其他文档方法。

6. It is important to acknowledge any code segments that were developed collaboratively or by another source.

   • 致谢任何协作开发或来自其他来源的代码段是很重要的。

7. Acknowledgement of a code segment(s) written by someone else and used in a program can be in the program documentation. The acknowledgement should include the origin or original author's name.

   • 可以在程序文档中对他人编写并在程序中使用的代码段进行致谢。致谢应包括来源或原作者姓名。

学生活动 Student Activities

1. Describe the purpose of a code segment or program by writing documentation.

   • 通过编写文档来描述代码段或程序的目的。

2. Acknowledge code segments used from other sources.

   • 承认从其他来源使用的代码段。

相关资源 Related Resources

• Professional Development > Teaching and Assessing Module: Explaining Processes from College Board
  • 专业发展 > 教学与评估模块：解释过程 来自大学理事会

必背单词

1. comment 注释
2. throughout 贯穿
3. documentation 文档
4. individually 个人的
5. acknowledge 致谢，承认