人事系统项目命名规范
整体规则:
1. 命名以英文为准,不可使用个人姓名或拼音;
2. 命名中遇项目开发通用词汇以通用命名为准;
3. 命名中遇一词多译,以词短优先原则,避免省略难以查询;
4. 词组翻译适当省略,每词首字母必须大写;
1 .NET工具箱控件命名规范
表1 VS.Net 2003 工具箱控件命名缩写规范(ASP.Net)
工具箱面板 | 控件 | 标识符前缀 | 标识符例子 |
Data | DataSet | ds | dsNorthwind |
OleDbDataAdapter | oleDbDa | oleDbDaNorthwind | |
OleDbConnection | oleDbConn | oleDbConnNorthwind | |
OleDbCommand | oleDbCmd | oleDbCmdCategories | |
SqlDataAdapter | sqlDa | sqlDaNorthwind | |
SqlConnection | sqlConn | sqlConnNorthwind | |
SqlCommand | sqlCmd | sqlCmdCategories | |
OdbcDataAdapter | odbcDa | odbcDaNorthwind | |
OdbcConnection | odbcConn | odbcConnNorthwind | |
OdbcCommand | odbcCmd | odbcCmdCategories | |
OracleDataAdapter | oraDa | oraDaNorthwind | |
OracleConnection | oraConn | oraConnNorthwind | |
OracleCommand | oraCmd | oraCmdCategories | |
DataView | dv | dvNorthwind | |
Web Forms | Label | lbl | lblMessage |
TextBox | txt | txtMessage | |
Button | btn | btnSeek | |
LinkButton | lnkBtn | lnkBtnSeek | |
ImageButton | imgBtn | imgBtnPicture | |
HyperLink | hlnk | hlnkSeek | |
DropDownList | ddl | ddlCategories | |
ListBox | lstBox | lstBoxCategories | |
DataGrid | dg | dgProduct | |
DataList | dlst | dlstProduct | |
Repeater | rpr | rprProduct | |
CheckBox | chkBox | chkBoxGender | |
CheckBoxList | chkBoxLst | chkBoxLstGender | |
RadioButtonList | rdoBtnLst | rdoBtnLstGender | |
RadioButton | rdoBtn | rdoBtnGender | |
Image | img | imgPicture | |
Panel | pnl | pnlMessage | |
PlaceHolder | plcHld | plcHldMessage | |
Calendar | cld | cldArrange | |
AdRotator | arto | artoArrange | |
Table | tbl | tblProduct | |
RequiredFieldValidator | rfVld | rfVldMessage | |
CompareValidator | cprVld | cprVldMessage | |
RangeValidator | rngVld | rngVldMessage | |
RegularExpressionValidator | rglExpVld | rglExpVldMessage | |
CustomValidator | csmVld | csmVldMessage | |
ValidationSummary | vldSum | vldSumMessage | |
Xml | xml | xmlMessage | |
Literal | liter | literMessage | |
TreeView | tv | tvDepartment | |
CrystalReportViewer | crv | crvProduct | |
Components | FileSystemWatcher | fsWtch | fsWtchProduct |
EventLog | evLog | evLogMessage | |
DirectoryEntry | dirEnr | dirEnrMessage | |
DirectorySearcher | dirSrch | dirSrchProduct | |
MessageQueue | msgQue | msgQueProduct | |
PerformanceCounter | pfmCnt | pfmCntMessage | |
Process | prc | prcProduct | |
ServiceController | svcCtrl | svcCtrlCategories | |
Timer | tmr | tmrProduct | |
ReportDocument | rptDoc | rptDocProduct | |
Html | Label | htmLbl | htmLblMessage |
Button | htmBtn | htmBtnSeek | |
Reset Button | htmRstBtn | htmRstBtnSeek | |
Submit Button | htmSmtBtn | htmSmtBtnSeek | |
Text Field | htmTxtFld | htmTxtFldSeek | |
Text Area | htmTxtArea | htmTxtAreaRemark | |
File Field | htmFileFld | htmFileFldSeek | |
Password Field | htmPwdFld | htmPwdFldUser | |
CheckBox | htmChkBox | htmChkBoxGender | |
Radio Button | htmRdoBtn | htmRdoBtnGender | |
Hidden | htmHidn | htmHidnProduct | |
Table | htmTbl | htmTblProduct | |
Flow Layout Panel | htmFLPnl | htmFLPnlProduct | |
Grid Layout Panel | htmGLPnl | htmGLPnlProduct | |
Image | htmImg | htmImgProduct | |
Listbox | htmLstBox | htmLstBoxProduct | |
Dropdown | htmDd | htmDdProduct | |
Horizontal Rule | htmHoznRule | htmHoznRuleProduct | |
2
按钮命名规范(~ 代表前缀)
按钮命名规范(~ 代表前缀)
类型 | 中文名称 | 规范命名 | 中文名称 | 规范命名 |
基本操作 | 新建 | ~New | 添加 | ~Add |
注册 | ~Register | 删除 | ~Delete | |
编辑 | ~Edit | 修改 | ~Modify | |
保存 | ~Save oracle人力资源管理系统 | 确定 | ~Define | |
提交 | ~Submit | 更新 | ~Update | |
取消 | ~Cancel | 返回 | ~Return | |
查看 | ~Seek | 排序 | ~Sort | |
重置 | ~Reset | 筛选 | ~Filter | |
查 | ~Find | 查询 | ~Search | |
详细查询 | ~DetailSearch | 高级搜索 | ~ AdvancedSearch | |
用户类型 | 锁定 | ~Lock | 解锁 | ~Unlock |
创建用户 | ~CreateUser | 分配角 | ~AllocateRoles | |
创建管理员 | ~CreateManager | 生成用户 | ~GenerateUser | |
密码恢复 | ~PasswordRecover | 修改用户名 | ~ChangeUserName | |
修改密码 | ~ChangePassword | |||
审核类型 | 审核 | ~Audit | 审核通过 | ~AuditPass |
审核拒绝 | ~AuditRefuse | 进入审核 | ~EnterAudit | |
批复拒绝 | ~ReplyRefuse | 批复通过 | ~ReplyPass | |
申请修改 | ~ApplyEdit | 保存未审核 | ~SaveUnaudit | |
保存且审核通过 | ~SaveAudit | 发回修改 | ~ReturnEdit | |
邮件 | 发布 | ~Publish | 发送 | ~Send |
发送消息 | ~SendMessage | 返回收件箱 | ~ReturnMessageBox | |
继续发送 | ~SendAgain | 添加收件人 | ~AddReceiver | |
其它类型 | 关闭权限 | ~AccessClose | 全部关闭 | ~AccessCloseAll |
导出数据 | ~ExportData | 导入数据 | ~ImportData | |
打印 | ~Print | 文件格式下载 | ~DownloadFileFormats | |
数据库备份设置 | ~DatabaseBackupSet | 一键恢复数据库 | ~RecoverDatabase | |
本地文件恢复数据库 | ~LocalRecoverDatabase | 备份 | ~Backup | |
数据库恢复 | ~DatabaseBackup | |||
3
项目必要文件命名规范(~ 代表前缀)
项目必要文件命名规范(~ 代表前缀)
Library 类库文件 | |||||
文件名 | 所在文件夹 | 文件类型 | 说明 | ||
Settings.settings | Properties | 设置文件 | 设置数据库连接 | ||
fig | —— | 配置文件 | 数据库连接字符串 | ||
AuditFlow.cs | —— | 类 | 审核流代码文件 | ||
DataBackup.xsd | —— | 数据集 | 备份数据表集合 | ||
DataBackupMgr.cs | —— | ||||
*.dbml | —— | LINQ to SQL类 | 项目数据表集合 | ||
Aspnet.dbml | —— | LINQ to SQL类 | 成员资格数据表集合 | ||
LogManage.cs | —— | 类 | 日志备份代码文件 | ||
Web 项目必要文件 | |||||
文件名 | 所在文件夹 | 文件类型 | 说明 | ||
AjaxControlToolkit | 引用 | DLL | 来自基类 | ||
eSchool.Common.Security | 引用 | DLL | 来自基类 | ||
eSchool.Web.UI.WebControls | 引用 | DLL | 来自基类 | ||
Library | 引用 | DLL | 来自类库(上面) | ||
App_Data | —— | 文件夹 | 存放系统XML文件 | ||
Blue | App_Themes | 文件夹 | 可完全来自其他系统 | ||
Common | —— | 文件夹 | 存放公共控件 | ||
DatePicker | Common | 文件夹 | 完全来自其他系统 | ||
UserControl | Common | 文件夹 | 公共控件存放处 | ||
~Selector.ascx | Common | 控件 | 公用控件命名方式 | ||
BasedConfigControl.cs | Common | 类 | 项目基类 | ||
Configs | —— | 文件夹 | 页面XML配置页面 | ||
Test | —— | 文件夹 | 用于测试的文件 | ||
Default.aspx | —— | 页面 | 登陆后的默认页 | ||
Default.Master | —— | 模板 | 登陆后所有页面的模板 | ||
Global.asax | —— | 全局文件 | 全局事件、ASP.NET配置 | ||
Login.aspx | —— | 页面 | 登陆页面 | ||
fig | —— | 配置文件 | 项目的配置文件 | ||
Web 项目所需文件 | |||||
文件名 | 所在文件夹 | 文件类型 | 说明 | ||
UserControl | 任何文件夹 | 文件夹 | 模块控件存放处 | ||
WUCAllItems.ascx | 任何文件夹 | 控件 | 数据控件 | ||
WUCForm.ascx | 任何文件夹 | 控件 | 表单控件 | ||
AllItems.aspx | 任何文件夹 | 页面 | 数据展示操作页面 | ||
DetailsForm.aspx | 任何文件夹 | 页面 | 查看页面 | ||
EditForm.aspx | 任何文件夹 | 页面 | 编辑页面 | ||
NewForm.aspx | 任何文件夹 | 页面 | 新增页面 | ||
fig | 任何文件夹 | 页面 | 文件夹访问角配置文件 | ||
4
数据库操作命名规范
数据库操作命名规范
视图:以View开头后接视图的英文名称
存储过程: 新增(Create~)、删除(Delete~)、修改(Update~)、
查询(Get~)、导入(ExportData~)
5 代码注释规范
函数详细注释
/// <summary>
/// 事件作用:
/// 创建标识:***(人名) 100101(时间)
/// 最后修改标识:***(人名) 100101(时间)
/// </summary>
函数简略注释
/// <summary>
/// 事件作用:
/// </summary>
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论