Panorama系统程序开发规范二
1匈牙利命名规
变动 前缀 类型
a Array
b Boolean
by Byte
c Char 符号型字符
cb Char Byte 符号型字符（没处）
cr ColorRef 颜色参考值
cxcy Length of xy (ShortInt) 坐标差（长度）
dw Double Word
fn Function
h Handle
i Integer
m_ Member of a class
n Short Integer
np Near Pointer
p Pointer lp Long Pointer
×(str) s String
sz String with Zero End 字符'\0'结尾字符串
tm Text 文容
w Word
xy Coordinate 坐标
2Panorama系统命名约定
21 VC中变量命名时前缀约定
Array a 例：CStringArray saText
BOOL b
UINT n
int i
short n
long l
WORD w
DWORD dw
float f
char c
char* psz
TCHAR* psz
LPCTSTR lpsz
CString str
COLORREF cr
LPLOGPALETTE lp (包括LP开头类型样)
POINT pt
CPoint pt
HANDLE h
HGLOBAL h (包括H开头类型样)
说明：
1果指述类型指针面规范前加 p
2果指述类型双重指针面规范前加 pp
3果类成员变量面规范前加 m_
4全局变量面规范前加 g_
5类型前加const命名约定变
22 VC中变量命名时缀约定
1MFC类
CWnd* pWnd 省方般该类途 (果某类成员应该前加 m_)：CView* pView
23 局部变量应量易懂简洁常见变量NumnCountijknlenpos offsetnReadNumindexnRetret stringfilename时变量ltmpftmptmpStrtempStr
24 函数命名应该见名知意CalcAllDataStyle()ReadDocDataFromTime()GetIndexInfo()
常见函数Init_ Open_ Create_ Get_ Set_ Read_ Load_ Write_ Start_ Stop_ Check_ Test_ Fill_
Process_ Sort_ Do_ Select_ Is_ Exist__Ex…
25 禁止汉语拼音命名
26代码中量具体数值定义成宏便维护：
#define MAX_DOWNLOADNUM 20
struct DownInfo m_DownInfo[MAX_DOWNLOADNUM]
27 VC中控件缩写：
ComboBox cmb
Edit edt
Dialog dlg
ListBox lst
Picture pic
Animate ani
3 编排
31 函数间空行分开程序中空行数目占816
32 变量定义放开始处态函数功相函数集中放起
33 声明变量时齐变量名定义时加注释说明
4 程序开发环境规约
41 工作目录结构规定
project name(项目名称)
——bin 执行文件
——log 日志文件
——lib 库文件
——include 头文件
——src 源程序
——dat 数文件
42工程中起作文件类应删工程目录非工程文件应该移走保持工程清洁避免混淆难理
43VC环境建议常头文件全部放入stdafxh中cpp开始处嵌入stdafxh避免头文件交叉引果严重交叉引适类声明
44 独立性较强模块抽出做成DLL控件COM组件该模块单独编写测试增强重性
45 较工程应留定消息接口插件接口等
46 工程版控制严格版格式xxxxxx必时Build次数日期高版量兼容低版法数协议
47 工程编译宏定义工程参数设置应正确作新工程时应检查工程参数否正确建议字节齐方式1字节齐
5 程序备份
51 备份记录
备份时注明备份日期增加功
52 定时备份
根程序量少天备份次半天备份
53 种介质备份
少硬盘做2备份软盘做备份机进行备份时放没密码保护ftp服务器发送email信箱中进行备份
54 软盘备份时应该掉中间文件执行文件vc动生成文件*clw *ncb *opt等删压成zip文件复制软盘中
6 VC程序界面设计规范
61颜色选择：
611 基调应WINDOWS颜色（灰色）窗体中白黑灰色外颜色总数宜超3种（生产学目软件言娱乐性软件做花哨
612 窗体控件（EDITRICH EDIT等编辑控件外）背景色宜灰色控件输入焦点鼠标焦点时较明亮颜色
613 非激活状态字体前景宜黑色背景灰色
62字体选择：
621 汉字字体般选宋体字体选10号
622 般选系统常字体绝选加入系统没字体
63图片选择
631 窗体工具拦中钮图标文字写写果写定tip提示户该钮完成功
632 钮中图片表达钮应功意义
633 宜普通钮图标做外观
64操作便利性
641 方便户输入控件应该tab键回车键排序特密码输入时应该回车切换输入框焦点
65数安全
651 程序退出写数等破坏数丢失操作应该户次确认机会
66帮助文件
661 帮助文件宜html格式hlp格式文件windows中
67窗体确定
671 般窗体应该户调整窗体初始长宽例4：3
672 考虑户会分辨率开发时应时流行分辨率
673 非必否宜模态窗体户选择窗体成模态窗体
674 应程序固定时(拖动窗口右角时改变窗体)应处理窗体变化时窗体控件位置变化
68视图选择(单文档界面类型)
681 简单文编辑器应程序选择CEditView
682 编辑信息文格式( RT F )文件应程序选择CRichEditView(选择导致应程序文档类选择CRichEditDoc类)
683 图形应程序选择CScrollView
684 简单监控帐目理应程序选择CListView
685 着手创建资源理器类型应程序请选择CTreeView(步骤中手工添加
CListView)
686 话框模板外创建视图选择CFormView(话框控件窗口占窗口诸钮编辑框)
69 MFC应程序类型选择：
691 果创建户界面需求限应程序果想界面完全单创建话框应程序典型话框应程序包括配置硬件设备应程序屏幕保护程序游戏程序等
话框易简洁字体控件组织搭配体简单复杂控件焦点Tab序等讲究视应场合适支持键盘简洁易前提力求性化设计更加友程序话框风格保持致
692 果应程序编辑文档应该选择单文档界面类型里编辑文档广义意思指文档文文件电子数表文件第三方数库表者二进制文件甚量硬件设备储存设置编辑仅仅表示中类型文档进行添加删修改操作
693 单文档界面应程序次允许处理文档果应程序实际次需处理文档诸监视组硬件设备应程序应该选择单文档界面否应该创建文档界面应程序开始时次编辑文档未显出处
694 文档界面应程序允许次编辑文档单文档界面应程序复杂带次少查文档方便
695 重窗口区域应弹出右键实现常见操作工具栏放常操作钮必时动态更换钮状态栏显示足够信息消息控Mainframe中单文档控View中话框弹出非模态话框控制控窗口中完成具体数处理放单独文件中设计成类App类中实现Ini读写数象定义析构全局变量赋值初始计算存盘退出等视图OnDrawGDI画图量存位图方式免闪烁
610 操作进度指示
6101 鼠标光标暂时变成沙漏形状指示漫长操作求户应该等
6102 沙漏光标指示短暂等长时间等考虑模式话框面显示简短消息描述正进行什处理
611 分隔线控件
6111 统起见分组框钮等控件做分隔线应做法：Picture Control属性设EtchedFrame该控件缩条直线
7
71 保证系统间兼容性int类型(系统间存储字节长度
)应longshort型
72 头文件名应写#includeabcdefh
73 系统中注释统
74 if(0 GetDataType(…))if(GetDataType(…) 0) 误写成编译层会报错
75 函数定义short GetInputType( const char * lpzInput)short GetInputType (char * lpzInput)免lpzInput函数体中破坏
76 变量定义时赋初值类析构时程序退出时判断释放变量
77 编码空间定充分预留编码时注意扩充性 ：定义保留字段供扩充
78 量符号型变量符号变量判断时易造成错误甚死循环量少
79 少mallocfreereallocnewdeletenewdelete规范C++语法通性强realloc易造成存抖动
710 代码中+2+4+sizeof(short)+sizeof(int) filename[40]filename[MAX_PATH]
附录A 程序维护手册格式说明
文档编号
版 号
密 级
文档名称 XXXX程序维护手册
项目编号：
项目名称：
开发部门：
项目负责：
编写 年 月 日
校 年 月 日
审核 年 月 日
批准 年 月 日
程序维护手册
1引言
1．1 编写目
[ 阐明编写维护手册目简述容指出读者象（程序维护员研发员）]
1．2 开发单位
[说明项目提出者项目委托单位开发单位场]
1．3 定义
[ 列出文挡中专业术语定义缩写词原文]
1．4 参考资料
[ 包括：a户操作手册b项目关文档列出资料作者标题编号发表日期出版单位资料源保密级]
2 系统说明
2．1 系统途
[ 说明系统具备功输入输出]
2．2 安全保密
[ 说明系统安全保密方面考虑]
2．3 总体说明
[ 说明系统总体功子系统作业作出综合性介绍图表方式出系统部分部关系]
2．4 程序说明
[ 说明系统中程序分程序细节特性]
2．4．1 程序1说明
2．4．1．1 功 [ 说明程序功]
2．4．1．2 方法 [ 说明实现方法]
2．4．1．3 输入 [ 说明程序输入媒体运行数记录运行开始时输入数类型存放单元程序初始化关入口求]
2．4．1．4 处理 [ 处理特点目：a 图表说明程序运行逻辑流程 b 程序转移条件c 程序约束条件d 程序结束时出口求e程序通信联结（运行控制） f 该程序产生供处理输出数类型存放单元g程序运行存储量类型存储位置等]
2．4．1．5 输出 [ 程序输出]
2．4．1．6 接口 [ 程序系统部分接口]
2．4．1．7 表格 [ 说明程序部种表项细节特性张表说明少包括：a 表标识符b 目c 表程序d 逻辑划分块部包括表项e 表基结构f 设计安排包括表控制信息表目结构细节中特性质表项标识位置途类型编码表示]
2．4．1．8 特运行性质 [ 说明户操作手册中没提运行性质]
2．4．2 程序2 说明 [ 程序1 说明相程序说明相]
3 操作环境
3．1 设备
[ 逐步说明系统设备配置极特性 ]
3．2 支持文件
[ 列出系统支持软件包括名称版号]
3．3 数库
[ 说明数库性质容包括安全考虑]
3．3．1 总体特征
[ ：a 标识符 b 数库程序c 静态数d 动态数e 数库存储媒体f 程序数库限制]
3．3．2 结构详细说明
3．3．2．1 说明该数库结构包括中记录项
3．3．2．2 说明记录组成包括首部控制段记录体
3．3．2．3 说明记录结构字段包括：标记标号字段字符长度位数该字段允许值范围
3．3．2．4 扩充：说明记录追加字段规定
4 维护程
4．1 约定
[ 列出该软件系统设计中全部规约定包括：a 程序分程序记录字段存储区标识标号助记符规b 图表处理标准卡片连接序语句记号中缩写出现图表中符号名c 软件技术标准d 标准化数元素极特征]
4．2 验证程
[ 说明程序修改进行验证求程（包括测试程序数）程序周期性验证程]
4．3 出错纠正方法
[ 列出出错状态纠正方法]
4．4 专门维护程
[ 说明文档方没提专门维护程：a 维护该软件系统输入部分（数库）求程验证方法b 运行程序库维护系统必须求程验证方法c 闰年世纪变更需时性修改等]
4．5 专维护程序
[ 列出维护软件系统备技术专程序（文件恢复程序淘汰时文件程序等）目录加说明容包括：a 维护作业输入输出求b 输入详细程硬件设备建立运行完成维护作业操作步骤]
4．6 程序清单流程图
[ 引资料提供附录出程序清单流程图]
附录B 部分编程常单词缩写
规：较短单词通掉元音形成缩写较长单词取单词头字母形成缩写单词家公认缩写
完整单词 缩写 缩写
A
average > avg
B
back > bk
background > bg
break > brk
buffer > buf
C
color > cr (clr)
control > ctrl
D
data > dat
delete > del
document > doc
E
edit > edt
error > err
escape > esc
F
flag > flg
form > frm
G
grid > grd
I
increment > inc
information > info
initial > init
insert > ins
image > img
L
label > lab
length > len
list > lst
library > lib
M
manager > mngr (mgr)
message > msg
O
Oracle > Ora
P
panorama > pano
password > pwd
picture > pic
point > pt
position > pos
print > prn
program > prg
S
server > srv
source > src
statistic > stat
string > str
Sybase > Syb
T
temp > tmp
text > txt
U
user > usr
W
window > wnd (win)
文档香网(httpswwwxiangdangnet)户传
《香当网》用户分享的内容，不代表《香当网》观点或立场，请自行判断内容的真实性和可靠性！
该内容是文档的文本内容，更好的格式请下载文档
1匈牙利命名规
变动 前缀 类型
a Array
b Boolean
by Byte
c Char 符号型字符
cb Char Byte 符号型字符（没处）
cr ColorRef 颜色参考值
cxcy Length of xy (ShortInt) 坐标差（长度）
dw Double Word
fn Function
h Handle
i Integer
m_ Member of a class
n Short Integer
np Near Pointer
p Pointer lp Long Pointer
×(str) s String
sz String with Zero End 字符'\0'结尾字符串
tm Text 文容
w Word
xy Coordinate 坐标
2Panorama系统命名约定
21 VC中变量命名时前缀约定
Array a 例：CStringArray saText
BOOL b
UINT n
int i
short n
long l
WORD w
DWORD dw
float f
char c
char* psz
TCHAR* psz
LPCTSTR lpsz
CString str
COLORREF cr
LPLOGPALETTE lp (包括LP开头类型样)
POINT pt
CPoint pt
HANDLE h
HGLOBAL h (包括H开头类型样)
说明：
1果指述类型指针面规范前加 p
2果指述类型双重指针面规范前加 pp
3果类成员变量面规范前加 m_
4全局变量面规范前加 g_
5类型前加const命名约定变
22 VC中变量命名时缀约定
1MFC类
CWnd* pWnd 省方般该类途 (果某类成员应该前加 m_)：CView* pView
23 局部变量应量易懂简洁常见变量NumnCountijknlenpos offsetnReadNumindexnRetret stringfilename时变量ltmpftmptmpStrtempStr
24 函数命名应该见名知意CalcAllDataStyle()ReadDocDataFromTime()GetIndexInfo()
常见函数Init_ Open_ Create_ Get_ Set_ Read_ Load_ Write_ Start_ Stop_ Check_ Test_ Fill_
Process_ Sort_ Do_ Select_ Is_ Exist__Ex…
25 禁止汉语拼音命名
26代码中量具体数值定义成宏便维护：
#define MAX_DOWNLOADNUM 20
struct DownInfo m_DownInfo[MAX_DOWNLOADNUM]
27 VC中控件缩写：
ComboBox cmb
Edit edt
Dialog dlg
ListBox lst
Picture pic
Animate ani
3 编排
31 函数间空行分开程序中空行数目占816
32 变量定义放开始处态函数功相函数集中放起
33 声明变量时齐变量名定义时加注释说明
4 程序开发环境规约
41 工作目录结构规定
project name(项目名称)
——bin 执行文件
——log 日志文件
——lib 库文件
——include 头文件
——src 源程序
——dat 数文件
42工程中起作文件类应删工程目录非工程文件应该移走保持工程清洁避免混淆难理
43VC环境建议常头文件全部放入stdafxh中cpp开始处嵌入stdafxh避免头文件交叉引果严重交叉引适类声明
44 独立性较强模块抽出做成DLL控件COM组件该模块单独编写测试增强重性
45 较工程应留定消息接口插件接口等
46 工程版控制严格版格式xxxxxx必时Build次数日期高版量兼容低版法数协议
47 工程编译宏定义工程参数设置应正确作新工程时应检查工程参数否正确建议字节齐方式1字节齐
5 程序备份
51 备份记录
备份时注明备份日期增加功
52 定时备份
根程序量少天备份次半天备份
53 种介质备份
少硬盘做2备份软盘做备份机进行备份时放没密码保护ftp服务器发送email信箱中进行备份
54 软盘备份时应该掉中间文件执行文件vc动生成文件*clw *ncb *opt等删压成zip文件复制软盘中
6 VC程序界面设计规范
61颜色选择：
611 基调应WINDOWS颜色（灰色）窗体中白黑灰色外颜色总数宜超3种（生产学目软件言娱乐性软件做花哨
612 窗体控件（EDITRICH EDIT等编辑控件外）背景色宜灰色控件输入焦点鼠标焦点时较明亮颜色
613 非激活状态字体前景宜黑色背景灰色
62字体选择：
621 汉字字体般选宋体字体选10号
622 般选系统常字体绝选加入系统没字体
63图片选择
631 窗体工具拦中钮图标文字写写果写定tip提示户该钮完成功
632 钮中图片表达钮应功意义
633 宜普通钮图标做外观
64操作便利性
641 方便户输入控件应该tab键回车键排序特密码输入时应该回车切换输入框焦点
65数安全
651 程序退出写数等破坏数丢失操作应该户次确认机会
66帮助文件
661 帮助文件宜html格式hlp格式文件windows中
67窗体确定
671 般窗体应该户调整窗体初始长宽例4：3
672 考虑户会分辨率开发时应时流行分辨率
673 非必否宜模态窗体户选择窗体成模态窗体
674 应程序固定时(拖动窗口右角时改变窗体)应处理窗体变化时窗体控件位置变化
68视图选择(单文档界面类型)
681 简单文编辑器应程序选择CEditView
682 编辑信息文格式( RT F )文件应程序选择CRichEditView(选择导致应程序文档类选择CRichEditDoc类)
683 图形应程序选择CScrollView
684 简单监控帐目理应程序选择CListView
685 着手创建资源理器类型应程序请选择CTreeView(步骤中手工添加
CListView)
686 话框模板外创建视图选择CFormView(话框控件窗口占窗口诸钮编辑框)
69 MFC应程序类型选择：
691 果创建户界面需求限应程序果想界面完全单创建话框应程序典型话框应程序包括配置硬件设备应程序屏幕保护程序游戏程序等
话框易简洁字体控件组织搭配体简单复杂控件焦点Tab序等讲究视应场合适支持键盘简洁易前提力求性化设计更加友程序话框风格保持致
692 果应程序编辑文档应该选择单文档界面类型里编辑文档广义意思指文档文文件电子数表文件第三方数库表者二进制文件甚量硬件设备储存设置编辑仅仅表示中类型文档进行添加删修改操作
693 单文档界面应程序次允许处理文档果应程序实际次需处理文档诸监视组硬件设备应程序应该选择单文档界面否应该创建文档界面应程序开始时次编辑文档未显出处
694 文档界面应程序允许次编辑文档单文档界面应程序复杂带次少查文档方便
695 重窗口区域应弹出右键实现常见操作工具栏放常操作钮必时动态更换钮状态栏显示足够信息消息控Mainframe中单文档控View中话框弹出非模态话框控制控窗口中完成具体数处理放单独文件中设计成类App类中实现Ini读写数象定义析构全局变量赋值初始计算存盘退出等视图OnDrawGDI画图量存位图方式免闪烁
610 操作进度指示
6101 鼠标光标暂时变成沙漏形状指示漫长操作求户应该等
6102 沙漏光标指示短暂等长时间等考虑模式话框面显示简短消息描述正进行什处理
611 分隔线控件
6111 统起见分组框钮等控件做分隔线应做法：Picture Control属性设EtchedFrame该控件缩条直线
7
71 保证系统间兼容性int类型(系统间存储字节长度
)应longshort型
72 头文件名应写#includeabcdefh
73 系统中注释统
74 if(0 GetDataType(…))if(GetDataType(…) 0) 误写成编译层会报错
75 函数定义short GetInputType( const char * lpzInput)short GetInputType (char * lpzInput)免lpzInput函数体中破坏
76 变量定义时赋初值类析构时程序退出时判断释放变量
77 编码空间定充分预留编码时注意扩充性 ：定义保留字段供扩充
78 量符号型变量符号变量判断时易造成错误甚死循环量少
79 少mallocfreereallocnewdeletenewdelete规范C++语法通性强realloc易造成存抖动
710 代码中+2+4+sizeof(short)+sizeof(int) filename[40]filename[MAX_PATH]
附录A 程序维护手册格式说明
文档编号
版 号
密 级
文档名称 XXXX程序维护手册
项目编号：
项目名称：
开发部门：
项目负责：
编写 年 月 日
校 年 月 日
审核 年 月 日
批准 年 月 日
程序维护手册
1引言
1．1 编写目
[ 阐明编写维护手册目简述容指出读者象（程序维护员研发员）]
1．2 开发单位
[说明项目提出者项目委托单位开发单位场]
1．3 定义
[ 列出文挡中专业术语定义缩写词原文]
1．4 参考资料
[ 包括：a户操作手册b项目关文档列出资料作者标题编号发表日期出版单位资料源保密级]
2 系统说明
2．1 系统途
[ 说明系统具备功输入输出]
2．2 安全保密
[ 说明系统安全保密方面考虑]
2．3 总体说明
[ 说明系统总体功子系统作业作出综合性介绍图表方式出系统部分部关系]
2．4 程序说明
[ 说明系统中程序分程序细节特性]
2．4．1 程序1说明
2．4．1．1 功 [ 说明程序功]
2．4．1．2 方法 [ 说明实现方法]
2．4．1．3 输入 [ 说明程序输入媒体运行数记录运行开始时输入数类型存放单元程序初始化关入口求]
2．4．1．4 处理 [ 处理特点目：a 图表说明程序运行逻辑流程 b 程序转移条件c 程序约束条件d 程序结束时出口求e程序通信联结（运行控制） f 该程序产生供处理输出数类型存放单元g程序运行存储量类型存储位置等]
2．4．1．5 输出 [ 程序输出]
2．4．1．6 接口 [ 程序系统部分接口]
2．4．1．7 表格 [ 说明程序部种表项细节特性张表说明少包括：a 表标识符b 目c 表程序d 逻辑划分块部包括表项e 表基结构f 设计安排包括表控制信息表目结构细节中特性质表项标识位置途类型编码表示]
2．4．1．8 特运行性质 [ 说明户操作手册中没提运行性质]
2．4．2 程序2 说明 [ 程序1 说明相程序说明相]
3 操作环境
3．1 设备
[ 逐步说明系统设备配置极特性 ]
3．2 支持文件
[ 列出系统支持软件包括名称版号]
3．3 数库
[ 说明数库性质容包括安全考虑]
3．3．1 总体特征
[ ：a 标识符 b 数库程序c 静态数d 动态数e 数库存储媒体f 程序数库限制]
3．3．2 结构详细说明
3．3．2．1 说明该数库结构包括中记录项
3．3．2．2 说明记录组成包括首部控制段记录体
3．3．2．3 说明记录结构字段包括：标记标号字段字符长度位数该字段允许值范围
3．3．2．4 扩充：说明记录追加字段规定
4 维护程
4．1 约定
[ 列出该软件系统设计中全部规约定包括：a 程序分程序记录字段存储区标识标号助记符规b 图表处理标准卡片连接序语句记号中缩写出现图表中符号名c 软件技术标准d 标准化数元素极特征]
4．2 验证程
[ 说明程序修改进行验证求程（包括测试程序数）程序周期性验证程]
4．3 出错纠正方法
[ 列出出错状态纠正方法]
4．4 专门维护程
[ 说明文档方没提专门维护程：a 维护该软件系统输入部分（数库）求程验证方法b 运行程序库维护系统必须求程验证方法c 闰年世纪变更需时性修改等]
4．5 专维护程序
[ 列出维护软件系统备技术专程序（文件恢复程序淘汰时文件程序等）目录加说明容包括：a 维护作业输入输出求b 输入详细程硬件设备建立运行完成维护作业操作步骤]
4．6 程序清单流程图
[ 引资料提供附录出程序清单流程图]
附录B 部分编程常单词缩写
规：较短单词通掉元音形成缩写较长单词取单词头字母形成缩写单词家公认缩写
完整单词 缩写 缩写
A
average > avg
B
back > bk
background > bg
break > brk
buffer > buf
C
color > cr (clr)
control > ctrl
D
data > dat
delete > del
document > doc
E
edit > edt
error > err
escape > esc
F
flag > flg
form > frm
G
grid > grd
I
increment > inc
information > info
initial > init
insert > ins
image > img
L
label > lab
length > len
list > lst
library > lib
M
manager > mngr (mgr)
message > msg
O
Oracle > Ora
P
panorama > pano
password > pwd
picture > pic
point > pt
position > pos
print > prn
program > prg
S
server > srv
source > src
statistic > stat
string > str
Sybase > Syb
T
temp > tmp
text > txt
U
user > usr
W
window > wnd (win)
文档香网(httpswwwxiangdangnet)户传
《香当网》用户分享的内容，不代表《香当网》观点或立场，请自行判断内容的真实性和可靠性！
该内容是文档的文本内容，更好的格式请下载文档