文档介绍：2014应届生学****报告
——
编写
覃凤俏
审核
部门
OLED—CIM
日期
天马有机发光技术机密资料 TM-OLED Confidential and Internal Use Only
天马有机发光技术机密资料 TM-OLED Confidential and Internal Use Only
文件的版本信息
OLED工艺技术组应届生学****报告
版本
Revision
更改日期
Date
更改内容/Revision Description
更改人
Changed By
审核
Checked By
2014-11-13
首次发行
覃凤俏
报告目录
Ⅰ
编码标准
学****小结
Ⅱ
天马有机发光技术机密资料 TM-OLED Confidential and Internal Use Only
天马有机发光技术机密资料 TM-OLED Confidential and Internal Use Only
编码标准
我们所使用的Fab OIC、Mou OIC、Fab Server端等系统都是由C#编程来实现,本次学****报告讲述学****到的AIM基础编码规则。
学****目的:通过规范定义来避免不好的编程风格,增强程序的易读性,便于自己和其它项目成员理解,便于程序后期的维护和功能修改。  养成良好的编程风格,提高程序可靠性,为大型项目多人合作开发的技术打下基础。
天马有机发光技术机密资料 TM-OLED Confidential and Internal Use Only
编码标准—文件组织形式
C#源文件
将每一个类分开放在一个文件中,以类名命名文件,。
例如:.CS、、。
目录布局
给每一个命名空间创建目录。
命名空间的名称不可使用点号。
例如:path→。
天马有机发光技术机密资料 TM-OLED Confidential and Internal Use Only
编码标准—ments
类的注释定义
/// ///////////////////////////////////////////////////////////////////////////////////
/// Class Name : MessageManager
/// Description : Query Manager for SQL Query Handling
/// Create By : Jhon
/// Create Date : 2013. 10. 22
/// Services
/// - GetData
/// - CheckData
/// - SaveData
/// Log
/// - Modified error routine of services. (2007-06-01 by )
/// ////////////////////////////////////////////////////////////////////////////////////
天马有机发光技术机密资料 TM-OLED Confidential and Internal Use Only
注释说明
编码标准—ments
节标题
注释描述
函数名称
功能说明
该过程完成什么(而不是怎么完成)
参数说明
每一个可能不明显的参数。参数分别在单独的行上,并嵌入注释。
返回值说明
函数返回值的类型及值。
全程变量说明
列出每个被影响的外部变量、控件或文件及其作用。
创建人
创建时间
2014/11/12
修改人
修改时间
2014/11/13
修改内容概要
哪些功能不能满足需求,或是Bug修正
天马有机发光技术机密资料 TM-OLED Confidential and Internal Use Only
文档注释: 在每个文件头必须包含注释说明。
通常单行C#注释包含XML标签,如:
多行XML注释,如:
文档items
程序中的API元素必须记录,如:<summary>, <param> , <exception>, …
编码标准—ments
/// <summary>
/// This class...
/// </summary>
/// <exception cref=”BogusException”>
/// This exception gets thrown as soon as a
/// Bogus flag gets set.
/// </exception>
天马有机发光技术机密资料 TM-OL