首页 文档书写与编程规范

文档书写与编程规范

举报
开通vip

文档书写与编程规范文档书写与编程规范惩罚措施:公司实行严格的文档书写与编程规范,并且在工作中随时进行规范性审查,发现不符合本规范代码段或者文件命名等,每次扣除2WM。审查机制:公司每周五下午为文档书写与编程规范审查时间,由WM技术委员会进行相关审查工作,发现问题将针对问题发布惩罚内容,并且录入公司管理系统。一、文档书写规范:1)文档命名:文档命名需要清晰描述文档内容以及最后更新时间修订类文档需要标注修订者文档名称+文档修订者+文档最后修改时间(使用完整年月日格式)示例:文档、编程规范制度_Jack_2)文档内容格式需统一:a.没有统...

文档书写与编程规范
文档书写与编程 规范 编程规范下载gsp规范下载钢格栅规范下载警徽规范下载建设厅规范下载 惩罚措施:公司实行严格的文档书写与编程规范,并且在工作中随时进行规范性审查,发现不符合本规范代码段或者文件命名等,每次扣除2WM。审查机制:公司每周五下午为文档书写与编程规范审查时间,由WM技术委员会进行相关审查工作,发现问题将针对问题发布惩罚内容,并且录入公司管理系统。一、文档书写规范:1)文档命名:文档命名需要清晰描述文档内容以及最后更新时间修订类文档需要标注修订者文档名称+文档修订者+文档最后修改时间(使用完整年月日格式)示例:文档、编程规范 制度 关于办公室下班关闭电源制度矿山事故隐患举报和奖励制度制度下载人事管理制度doc盘点制度下载 _Jack_2)文档内容格式需统一:a.没有统一文档格式规范的,需要设置公司统一的页眉页脚格式b.有统一文档格式规范的按照统一文档格式规范书写文档二、代码命名规范:1.通用约定:1)函数命名,变量命名,文件命名应具备描述性;不要过度缩写.类型和变量应该是名词,函数名可以用“命令性”动词。2)短时使用的循环用变量,可以使用诸如i,n之类的简短词语。3)可以使用单词或者拼音,但需要统一。2.类名:文件名和类名相同,或使用编程框架内的命名习惯类名使用首字母大写的形式例:3.文件名:全部小写,单词之间使用下划线,或使用编程框架内的命名习惯例:operation_4.变量名称:变量名一律小写,单词之间用下划线连接,或使用编程框架内的命名习惯北京天坦智能科技有限责任公司2my_exciting_local_variabl5.函数名称:函数名的每个单词首字母大写,没有下划线,首单词首字母小写,或使用编程框架内的命名习惯:addTableEntry()deleteUrl()6.html标签属性命名:1)所有标签属性赋值必须加上双引号:id=“tag_value”2)id,class,name属性符合通用约定和变量名约定三、代码风格要求:1.使用以下缩进样式,或使用编程框架内的代码风格:所有缩进使用Tab键为缩进单位,Tab键设定为4空格四、注释编写要求:必须含有必要的注释,代码中必要的注释包含:1)算法解释2)程序 流程 快递问题件怎么处理流程河南自建厂房流程下载关于规范招聘需求审批流程制作流程表下载邮件下载流程设计 注释3)函数功能注释4)函数参数注释5)特殊变量意义注释6)其它特殊操作注释7)保证代码本身高度的可读性,变量名称更有意义、更贴切,代码本身是最好的注释8)所有注释语句要礼貌、描述要客观清晰,言简意赅、直接了当9)代码注释先行原则,先写注释再写代码10)类注释:北京天坦智能科技有限责任公司11)函数注释:12)文件注释:/***************************************************Created:2011-11-23*Info:住院医师,病人体征数据获取以及分析处理接口*@Tiantanhehe(C)2011-3011Tiantanhehe*@AuthorDongJie<>****************************************************/五、SVN代码版本管理管理规范:1.上传SVN的代码不能再带有测试代码,必须删除测试代码2.上传SVN时必须进行二次代码Review,根据SVN对比复查此次代码3.SVN日志提交需求3北京天坦智能科技有限责任公司1)本地测试稳定后方可提交SVN2)每次提交SVN以单一任务改进点为基准提交,不得掺杂多个改进(如果为可合并型任务可以合并提交)3)每次提交SVN,需要详细标明改进内容,备注相关配置,示例:六、代码编写性能检查规范:性能负载模拟工具:ApacheJMeter3.3及以上版本JMeter测试模板,使用公司通用测试模板tiantan_emr_适用范围:PHP或JAVAWEB端相应开发功能负载压力增加方式:模拟相应开发函数访问请求,20并发请求通过指标:99%Line小于1.5SAverage小于1.2S特殊模块超过此指标特殊申请七、禅道任务管理要求:1)根据禅道需求、bug或者产品分工,创建禅道任务2)通过禅道任务进行工作日志记录3)启动编码以及编码过程中,通过禅道进行开发实现思路梳理4)实时更新禅道开发状态
本文档为【文档书写与编程规范】,请使用软件OFFICE或WPS软件打开。作品中的文字与图均可以修改和编辑, 图片更改请在作品中右键图片并更换,文字修改请直接点击文字进行修改,也可以新增和删除文档中的内容。
该文档来自用户分享,如有侵权行为请发邮件ishare@vip.sina.com联系网站客服,我们会及时删除。
[版权声明] 本站所有资料为用户分享产生,若发现您的权利被侵害,请联系客服邮件isharekefu@iask.cn,我们尽快处理。
本作品所展示的图片、画像、字体、音乐的版权可能需版权方额外授权,请谨慎使用。
网站提供的党政主题相关内容(国旗、国徽、党徽..)目的在于配合国家政策宣传,仅限个人学习分享使用,禁止用于任何广告和商用目的。
下载需要: 免费 已有0 人下载
最新资料
资料动态
专题动态
个人认证用户
DNSJDS
暂无简介~
格式:doc
大小:13KB
软件:Word
页数:3
分类:
上传时间:2022-04-16
浏览量:0