IT职业英语二级软件类课后答案Unit 06.ppt

* * * * * * * * * * * * * * * * * * * 4. Translations. a) A good name for a routine clearly describes everything the routine does. b) Special care should be given to the naming of header files because of potential conflicts between modules. c) When applicable, all source documentation should be in a format compatible with the generic formatting defined by the original programming language. d) Block comments are used to provide descriptions of files, methods, data structures and algorithms. 一个好的例程名能明确地描述该例程的功能。 注意头文件的命名以避免模块间潜在的冲突。 在可应用的时候，所有源文档的格式应适当地与原始程序语言定义的通用格式兼容。 块注释用来说明文件、方法、数据结构和算法。 6.3 Source code documentation… e) Short comments can appear on a single line indented to the level of the code that follows. f) Very short comments can appear on the same line as the code they describe, but should be shifted far enough to separate them from the statements. g) The information provided by documentation comments delivers very important messages to other developers and users. h) Documentation comments, specially in Java, describe the classes, interfaces, constructors, methods, and fields. 短注释可以出现在单一一行，缩进位置与其后的代码相同。 若注释非常短，可与代码同行，但要空出足够的间距。 文档注释向其他开发人员和用户传递非常重要的信息。 文档注释，特别是在Java语言中，说明类、接口、构造函数、成员方法和成员变量。 6.3 Source code documentation… The five types of documentation comments, as mentioned in the article, are listed below. Try to use as few words as possible to describe them. Copyright information: Module comments: Revision history: Code specification: Source documentation: provides the copyright and licensing information of the code. 6.3 Source code documentation… indicates where the reader can find the sources of the information. contains enough information about the programmer’s destination. records the history of changes in the source files. describes the classes, interfaces, constructors, methods, and fields. 6.4 E-mail technical writing A. Replying or forwarding e-mails properly Key points: Every message other than spam or junk