Yii2编程入门：程序清单编写规范详解

在"程序清单-yii2初学者入门 yii2 for beginners"这一文档中，主要介绍了编写专业文档时关于程序清单（Program Listings）的具体规范和要求。以下是一些关键知识点： 1. 编号规则：程序清单需要有明确的编号系统，章节内的清单按顺序编号，如“程序清单3.1”、“程序清单3.2”，并使用“题注”进行标注。章节间的引用使用“交叉引用”的方式，确保一致性。 2. 题注：题注应简洁明了，位于清单顶部，避免与其他清单雷同，并且结尾不加标点。 3. 字体和排版：程序清单内的文字采用宋体（中文）和Times New Roman（英文）字体，字号为小五号。函数、程序及注释中的符号和标点使用特定的格式，如中文冒号和西文标点。 4. 格式要求：清单应保持简洁和整齐，底纹使用10%的灰色调。如果有函数头，需遵循特定格式，包括中文说明、符号“”和空格等，函数功能和特殊说明应对齐。 5. 注释：程序注释使用“/* ... */”格式，注释与文字间有一空格，所有注释应保持对齐。 6. 代码缩进：代码有不同的缩进规则，如宏定义顶格写，函数名顶格，全局变量顶格，函数内代码则退格，汇编语言中的指令也应退格。 此外，文档还涉及其他部分，如修订历史、目录、标题、正文、题注、表格、图片、公式、注解、附录、参考文献等的规范，都有详细的说明和示例图片分解，帮助读者理解如何在实际文档中正确运用这些规范。例如，图片分解部分展示了如何清晰地展示函数头书写和宏定义的格式。对于每个部分，都有具体的操作指南，确保文档的专业性和一致性。 这些规定旨在提升文档的可读性、组织性和准确性，对于从事IT文档写作的初学者来说，理解和遵循这些规范至关重要，尤其是在使用Yii2框架进行开发时，文档的清晰度将直接影响到他人的理解和学习效率。