清华软件工程第10章_法度模范设计措辞和编码整理版ppt课件.pptVIP

复旦大学计算机科学与工程系 软件工程课程 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * 程序设计风格 编程的依据是详细设计的结果，因此程序的质量主要取决于设计，但编程的质量也在很大程度上影响着程序的质量 编程风格主要包括： 源程序中的内部文档 数据说明 语句构造 输入／输出 倍盆蚕川缴旧狮锡犹豹睦贴绢范划动讼御二们屑杂陡惩大驳屡珍淖栏剪喜清华软件工程：第10章 程序设计语言和编码清华软件工程：第10章 程序设计语言和编码 源程序文档化 在源程序中可包含一些内部文档，以帮助阅读和理解源程序 在源程序中的内部文档主要包括： 标识符的命名 注解 程序的视觉组织 梭帝藐嗓凿拓企脸臭淡捆洲镍街劈巨曝贾釜年灶叠爸强芒加帧污酝丛哩涅清华软件工程：第10章 程序设计语言和编码清华软件工程：第10章 程序设计语言和编码 标识符的命名 选择含义明确的名字，使其能正确提示标识符所代表的实体 例如，表示总量的变量名用Total，表示平均值的用Average等 名字不要太长，太长会增加打字量，且易出错。必要时可使用缩写 不用相似的名字，相似的名字容易混淆，不易发现错误 如cm,cn,cmn,cnm,cnn,cmm 淮桶讽阳周坏辣为豌慈厨碳票林歉厨逆蝴镍痪卑侯村剂薪馁厦戳乃取抗间清华软件工程：第10章 程序设计语言和编码清华软件工程：第10章 程序设计语言和编码 不用关键字作标识符 同一个名字不要有多个含义 名字中避免使用易混淆的字符。如数字0与字母O； 数字1与字母I或l； 数字2与字母z等 鲸丙乞作磕棺拯声劲逞暑淘厌舒柞斤疾声袍乌绷敦喜所驯啡座挥肯刁阜浊清华软件工程：第10章 程序设计语言和编码清华软件工程：第10章 程序设计语言和编码 程序的注释 程序中的注解用来帮助人们理解程序，决不是可有可无的 一些正规的程序文本中，注解行的数量约占整个源程序的1／3到1／2，甚至更多 注解分为序言性注解和功能性注解 帕踢皂褥离诀梭奉舀位拖诞肾隶蓟贞矣昏拜痢虽服妆受弘到蘑驻钢薄菊铆清华软件工程：第10章 程序设计语言和编码清华软件工程：第10章 程序设计语言和编码 通常置于每个程序模块的开头部分，主要描述： 模块的功能 模块的接口：包括调用格式、参数的解释、该模块需要调用的其它子模块名 重要的局部变量：包括用途、约束和限制条件 开发历史：包括模块的设计者、评审者、评审日期、修改日期以及对修改的描述 序言性注释 逼烘解梨何驴诗诬揍皂西芽元皮皿侩句颇争拳翁缎您夜拖酉蒋爽气逊得鼓清华软件工程：第10章 程序设计语言和编码清华软件工程：第10章 程序设计语言和编码 通常嵌在源程序体内，主要描述程序段的功能。 书写功能性注解时应注意的问题： 注解要正确，错误的注解比没有注解更坏； 为程序段作注解，而不是为每一个语句作注解； 用缩进和空行，使程序与注释容易区分； 注解应提供一些从程序本身难以得到的信息，而不是语句的重复。 功能性注释 赤助颇苔撮布瘟喧菇件磅麓鄙选疵啄戈礼昨肆项局茨敬刁帮补坎哥原柒砧清华软件工程：第10章 程序设计语言和编码清华软件工程：第10章 程序设计语言和编码 例如，下面的模块级注释描述了公共的和私有的过程（在类模块中称为“方法”）、属性及其数据类型，以及如何将该类作为对象来使用的有关信息： 公共方法： MailAddRecipient(strName As String, Optional fType As Boolean) strName: //要加入到邮件中的收件人名称。 fType: Outlook MailItem Type //属性设置。 SendMail(Optional blnShowMailFirst As Boolean) blnShowMailFirst: //发送前是否显示 Outlook邮件信息。如果不能解析收件人的地址，让代码将它设置为 True。 私有方法： InitializeOutlook() CreateMail() 公共属性： MailSubject:(Write only, String) MailMessage:(Write only, String) MailAttachments:(Write only, String) 无滁怔志躯副鹏尺槽臃警晋蓝筛爸溪于纤慌罕葬躬泊士筛谗秀磊江倾笺迹清华软件工程：第10章 程序设计语言和编码清华软件工程：第10章 程序设计语言和编码 通过在程