当前位置:文档之家› 编码编写规范

编码编写规范

编码编写规范
编码编写规范

XX公司文件编号管理规定

广西桂平市中润地产顾问有限公司 中润行通字第(2017)001号 关于发布【锦洲·时代广场】营销中心 《文件编号管理规定》的通知 公司各部门: 为有效管理公司、部门层级起草的文件,确保各职责单位所使用的文件为有效版本,现结合我司锦洲时代广场项目工作实际情况,特制订广西桂平市中润地产顾问有限公司《文件编号管理规定》,具体如下。 该规定自2017年3月1日份起生效,请各部门遵照执行。 特此通知 广西桂平市中润地产顾问有限公司 2017年3月3日

报:总经理 抄:行政部、总经办、财务部、策划部、销售部、按揭部 广西桂平市中润地产顾问有限公司 《文件编号管理规定》 一、目的 对公司、部门层级起草的文件进行有效管理,确保各职责单位所使用的文件为有效版本。 二、适用范围 广西桂平市中润地产顾问有限公司范围内。 三、文件编号细则 1、文件编号格式 2、文件分类

公司文件分为以下几类: 合同类:包括合同、协议、合作意向书等。与客户签订的商品房买卖合同、认购书、协议书等属于广西锦洲投资建设有限公司名义签订,不在本规定范畴。 制度、规定类:包括公司的各项管理制度、规定、决定等。 通知类:以公司、各部门名义下发或向有关合作单位发出的各项通知。 纪要类:以公司名义召开会议形成的各项会议纪要。 公函类:以公司名义向各合作企业、单位、组织或个人发出的函。 申请、请示类:以公司名义向各合作单位、企业、上级机构、行政单位发出的各类申请、请示。 报告、总结类:以公司名义向上级单位、行政机构提交的各类报告。 文件类别简称:

发文时对照文件类别使用上述简称。 3、发文单位及简称 凡是向外单位发文的都使用公司名义,发文单位简称为空白。对内发文的,按发文单位使用简称。 公司名称统一用“中润”。 4、年份和顺序号 “年份”属于顺序号的一部分,“年份”记录文件发布的年份,“顺序号”记录该文件在当年发布的顺序。 顺序号不区分文件类别,统一编号。 5、示例 (1)策划部向锦洲公司申请费用: 中润申字第【2017】×××号 (2)行政部发布会议纪要: 中润行纪字第【2017】×××号

项目编码规范

项目代码编程规范 1.应用范围 本规范应用于采用J2EE规范的项目中,所有项目中的JAVA代码(含JSP,SERVLET,JAVABEAN,EJB)JS代码、HTML代码及数据库设计均应遵守这个规范。同时,也可作为其它项目的参考。 2.设计类和方法 2.1. 创建具有很强内聚力的类 方法的重要性往往比类的重要性更容易理解,方法是指执行一个独立逻辑的一段代码。类常被错误的视为是一个仅仅用于存放方法的容器。有些开发人员甚至把这种思路作了进一步的发挥,将他们的所有方法放入单个类之中。 之所以不能正确的认识类的功能,原因之一是类的实现实际上并不影响程序的执行。当一个工程被编译时,如果所有方法都放在单个类中或者放在几十个类中,这没有任何关系。虽然类的数量对代码的执行并无太大的影响,但是当创建便于调试和维护的代码时,类的数量有时会带来很大的影响。 类应该用来将相关的方法组织在一起。 当类包含一组紧密关联的方法时,该类可以说具有强大的内聚力。当类包含许多互不相关的方法时,该类便具有较弱的内聚力。应该努力创建内聚力比较强的类。 大多数工程都包含许多并不十分适合与其他方法组合在一起的方法。在这种情况下,可以为这些不合群的方法创建一个综合性收容类。 创建类时,应知道“模块化”这个术语的含义是什么。类的基本目的是创建相当独立的程序单元。 2.2. 创建松散连接和高度专用的方法 2.2.1.使所有方法都执行专门的任务 每个方法都应执行一项特定的任务,它应出色的完成这项任务。应避免创建执行许多不同任务的方法。 创建专用方法有许多好处。首先调试将变得更加容易。 2.2.2.尽量使方法成为自成一体的独立方法 当一个方法依赖于其他方法的调用时,称为与其他方法紧密连接的方法。紧密连接的方法

上市公司 制度文件编写管理办法

本页为著作的封面,下载以后可以删除本页! 【最新资料Word版可自由编辑!!】

1目的 为了使公司的制度、表单编写系统化、标准化,具有延续性和追溯性,特制定本办法。 2适用范围 适用于本公司所有的制度、表单的编写、编号。 3权责 3.1总经理:负责本办法的审批 3.2人事行政部:负责本办法的制定、修订、解释及组织实施; 4主要内容 4.1编号方法 4.1.1编号原则:正式颁布的各种文件应有专用的编号,同类文件保持编号的一致性。 4.1.2编号分类: 4.1.2.1公司代号:公司简称取二至四个字母大写组成(如普旺:PW); 4.1.2.2编号构成:公司代号-管理体系代号(发布年号)-制度层次代号文件序号; 4.1.2.3管理体系代号:以管理体系简称取两个拼音字母大写组成; 4.1.2.4制度层次代号:以分类表列明代号编写; 4.1.2.5文件序号:为同类文件资料的顺序号编制

5.1.3体系代号、层次代号分类表(由人事行政部确定): 例举人事行政部: 2014年度发布的《招聘管理制度》 编号为:GS-CW (2014)-0001 文件序号 发布年号 管理体系代号 公司代号 表单编号为:GS-BM (2014)-0001-01 顺序号 与上同 5.1.4文件版本 文件版本状态标识为1.0版,其中1是版号(1、2、…),0是修订次数(0、1、2、…), 如1.0表示第1版文件经发布,试行版。如1.1表示第1版文件经第一次修订,改正时 不必改版。 5.2书写用纸、格式及字体 5.2.1封面见附件1; 5.2.2修订记录见附件2;当相关作业文件需修改时使用;

文件编号管理办法

一、目的 加强公司文件的标准化管理,便于文件的识别、追溯和控制,规范存档,确保公司重要文件具有唯一编号,保证公司文件体系有效运转。 二、适用范围 本办法适用于本公司经营管理过程中,所涉及的全部文件的编号管理和控制,具体如下: 1、管理类文件:包括公司规章制度、办法等文件; 2、合同协议类文件:包括公司各类合同协议(招投标)文件等; 3、技术类文件:包括工艺流程文件、产品说明文件等; 4、表格类文件:包括岗位说明、绩效考核等文件; 5、其他类文件:包括会议、决议记录、传真等。 三、编号方法 状态及版本号⑤ 发文日期④ 文件类型③ 发文部门② 公司名称代码① 1 公司全称:安徽人和建设科技有限公司 简称:人和建设代码:RHJS 2、发文部门 综合管理部:ZG 项目工程部:XM 待续 3、文件类型 (1)管理类—RUS. (2)合同协议类—CON.(此条适用流水号编制,参加6.1)) (3)技术类—SOP. (4)表格类—GF. (5)其他类—SR.

4、发文日期 日期格式由年月日表示yyyymmdd如20171010 5、文件状态与版本号 5.1文件状态符号的说明: Add.版本号增编 Corr.版本号更正 Rev.版本号发布(新发布或取代已发放的文件) 5.2版本号的使用: 第一版(原件)用Rev.1.0表示 对第一版进行细部调整用“状态符号Add.1.1 / 1.2 ……”表示 对第一版进行结构修改用“状态符号Corr.2.0 / 3.0 ……”表示 例:公司综合管理部在2017年10月1日发布第一版薪酬管理制度,文件编号为:RHJS-ZG-RUS-20171001-Rev1.0 6、流水号的使用:适用于公司合同协议类文件,流水号由001开始依次为002、003.......,除附件流水号起始值为01外,其余文件流水号起始值均为001。所有文件流水号在每年1月1日自动归零。 6.1合同协议类编号格式:RHJS-ZG-CON-C-201710-001 6.2格式说明:公司名称-部门编号-合同编号-合同类型-年月-流水号 6.3合同类型(C-承揽合同(施工合同);P-采购合同;H-劳动合同;Z-租赁合同;T-技术开发合同;O-其他合同) 四、编号管理 1、公司所有审批完毕的文件必须由综合管理部统一编号,并登记入档后方可发布。 2、本办法解释权归属公司综合管理部,未尽事宜另行补充,经总经理批准后执行。

项目编码规则

□机密文件■管制文件□一般文件 主题: 项目编码规则 文件编码: 版本:V5.2 机种:———— 生效日期:发行日生效PAGE 0 OF 13 (变更历史记录): 变更次数变更内容变更人变更日期 0 首次发行,第一版1999.12.5 1 物料编码规则维护2000.5.33 2 项目编码规则维护,变更码长和分类、取消延申码,2001.2.9 3 项目编码规则维护, 2001.6.25 4 项目编码规则维护, 2002-4-29 5 项目编码规则维护, 2002-5-16 6 项目编码规则维护,数码产品2002-8-13 7 项目编码规则维护,笔记本2003-3-7 8 项目编码规则维护,笔记本编码2003-12-29 9 根据现有业务流程进行版本升级徐斐2004-2-28 10 项目编码规则维护,PTO编码徐斐2004-5-30 分发部门□研发中心□生产管理□财务□行政部 □采购□市场□品管部□信息管理部□商务□计划物控□ □客服□产品销售□□ 会签部门 (部门长) 批准审核拟稿TCL电脑科技(深圳)有限公司

目录 1 目的. (3) 2 范围. (3) 3 权责. (3) 3.1信息管理部 (3) 3.2研发部 (3) 3.3产品管理部 (3) 3.4其它部门 (3) 3.5 TCL万维科技(深圳)有限公司 .......................................................................... 错误!未定义书签。4定义 . (3) 5 TCL电脑科技有限责任公司项目编码规则 (4) 5.1 成品编码规则 (4) 5.2零部件的编码规则 (6) 5.3 PC主机电脑及外设所用项目的选项类项目编码规则 (10) 5.4 笔记本主机电脑及外设所用项目的选项类项目编码规则 (12) 5.5固定资产编码规则 (17) 5.6办公用品编码规则 (18) 5.7促销品编码规则 (18) 5.8客服的服务用品编码规则 (18) 5.9外协项目的编码规则 (18) 5.9工程物料编码规则 (18) 6 TCL万维科技(深圳)有限公司项目编码规则 (18) 7项目编码规则的维护. (19) 8相关文件. (19)

工程项目编码规则及管理办法

中船重工船业有限公司工程项目编码规则及管理办法 1. 范围 本办法规定公司各种工程编码分类和编码实施规则及其管理办法。 本规则适用于公司内部所有工程项目的编码计划编制、领发料、财务核算、计算机信息处理等。 2. 工程编码类别及其编制规则说明 2.1工程编码类别分为船舶产品工程、非船产品工程、基建工程、自营工程、设备大修、设备维修、设备技改、安全设施及其它工程。 2.2产品工程编码的编制方法 2.2.1 大吨位运输船舶(千吨位以上)工程号的编制方法 2.2.1.1 编码共6 位。前两位为船舶产品载重吨位或承载体积前两位数;第三位为同载重吨位船舶型号,无型号用0 表示,有型号时分为Ⅰ型、Ⅱ型、Ⅲ型等,分别用1、2、3表示,以此类推;第四、五、六位为公司大吨位运输船舶接单顺序号。 2.2.1.2 图示

例如:公司接单第31 艘70000 吨散货船工程编码为:700031 。 公司接单第18 艘33000 吨散货Ⅰ型船工程编码为:331018 。 2.2.2 商务船工程号的编制办法 2.2.2.1 编码共6位。前两位统一名称为SW(商务);第三、四两位为商务船的长度,五、六两位为商务船接单顺序号。 2.2.2.2 图示 例如:公司接单第1 艘35 米长的商务船,工程号为:SW3501 2.2.3 小吨位(百吨位)运输船工程号的编制办法 2.2. 3.1 编码共6 位。前两位统一名称为YS(运输);第三、四两位为运输船的吨位前两位,五、六两位为公司小吨位运输船接单顺序号。 2.2. 3.2 图示 例如:公司接单第1 艘载重吨为20 吨的运输船,工程号:YS2001

文件编号管理规定

文件编号管理规定 一、目的 为了规范各部门和各管理体系文件的编号及文件的日常管理工作,使文件在使用过程中不发生内容重复、遗留,便于文件的检索和存档,特制定本办法。 二、适用范围 适用于君霖纺织所有文件&制度的编号。 三、术语 根据文件性质分为体系文件、技术文件、合同文件、文书文件四类。 1、体系文件指质量手册、程序文件、管理文件、管理通知、质量记录等与质量体系有关的文件。 2、技术文件指产品技术文件、工艺技术文件、检验技术文件、外来技术文件和其它技术文件五大类。 3、合同文件指中标通知书、专用合同条款、通用合同条款、经合同双方确认进入合同的其他文件。 4、文书文件指公司行政文件、行政规章、各种请示、一次性的通知等其它与质量体系无直接关联的文件。 四、职责 1、办公室负责体系文件、技术文件的编号和归口管理。 2、人力资源部负责文书文件的编号和归口管理。 3、财务部负责合同文件的编号和归口管理。 五、正文 1、文件编号规则 1.1外来文件执行原编号。 1.2体系文件根据体系文件编号规则进行编号,例:JLFZ-QM-1701。 1.3技术文件根据技术文件编号规则进行编号,例:JLFZ-JS-1701。 1.4合同文件根据合同文件编号规则进行编号,例:JLFZ-RZ-1701。 1.5文书文件根据文书文件编号规则进行编号,例:JLFZ-CW-1701。 2、文件编写规范

2.1文件分为标题→编号→目的→适用范围→术语→职责→正文→接口文件→记录→附则等十部分(严格执行以上编写顺序),可依据文件性质进行适当删减。 2.2体系文件编写规范(见附件一) 2.3技术文件根据技术文件编写规范进行编写。 2.4合同文件根据合同文件编写规范进行编写。 2.5文书文件编写规范 2.5.1红头文件编写规范(见附件二) 2.5.2报告/请示编写规范(见附件三) 2.5.3会议纪要编写规范(见附件四) 2.5.4一般性通知编写规范(见附件五) 2.5.5通报编写规范(见附件六) 六、附则 6.1本办法从2017年4月10日开始执行。 6.2本办法的解释权归办公室。

项目编码管理规定

项目编码管理规定 1 目的 为了规范集团项目编码管理,明确各编码规则的使用范围,特制订本规则。 2 适用范围 本规则适用于集团公司各单位及所全资子公司,合资公司参照执行。 3 项目编码规则 项目编码长度为12位,根据项目性质的不同,分别制订不同的编码规则。 3.1营销项目编码规则 3.1.1营销项目已立项后,由市场管理部下发唯一的项目名称及项目编码;营销项目转化为施工项目时,延用营销项目的名称和编码。 3.1.2参考《集团公司营销项目立项及管理办法》(ZD-ZH-030/V0-2013),具体方法如下: 3.1.3 项目编码共12位,名称标准为“产业单位+客户单位/区域+产品/服务内容+年份/批次”a)第一至二位为字母,代表产业单位,取自单位名称拼音; b)第三至四位为字母:代表销售区域/办事处,取自区域/办事处名称拼音; c)第五至八位为字母:代表项目主要产品及服务内容,取自集团产品及服务目录三级、四级目录拼音,产品目录为三字内容时,四位字母代码第一位为大写字母“O”,项目服务内容为多个产品目录组合内容时,以主要产品目录名称编制; d)第九至十二位为数字:代表年份及批次,以上字段相同时加以区别。

3.2 关联交易项目编码规则 3.2.1关联交易项目编码规则为:“营销项目编码(复制)”+“ERP法人代码(3位)”+“ERP 事业部代码(2位)” 3.2.2复制的营销项目编码与ERP法人代码(3位)之间用“-”符号连接 3.3公共费用项目编码规则 3.3.1公共费用项目使用范围 a)产业单位无法按项目进行归集,需要按一定原则进行分摊的成本; b)职能单位发生的费用; c)营销单位无法归集到营销项目的费用。 3.3.2公共费用项目统一使用四个零“0000”。 3.4虚拟项目编码规则 3.4.1虚拟项目使用范围 a)以生产、加工、制造为主要业务的单位,包括管材集团、油气井工具中心、陶粒公司;b)以非施工类服务为主要业务的单位,包括软件公司、集团总部。 3.4.2虚拟项目统一使用十二个零“000000000000”。 3.5期初上线项目编码规则 3.5.1期初上线项目使用范围 PA项目期初上线时期,未进行营销立项的项目使用 3.5.2国内期初上线项目统一使用十二个九“999999999999” 3.5.3国际期初上线项目按法人分别建立,编码规则为“ERP法人代码(3位)”+“9个0” 4 子项目编码规则 子项目编码长度为7位,根据子项目的性质不同,制订不同的编码规则。 4.1施工子项目编码规则 4.1.1施工子项目编码规则为“事业部唯一识别码(1位)”+“年份(2位)”+“流水号(4 2

文件编写管理办法(1)

成渝钒钛科技有限公司支持性文件CFGS(A)0401.1-15 文件编写办法 A/0 受控状态: 分发编号: 编制人:陈瑜 初审人:王学良 审核人:代宾 批准人:袁勇 实施日期:2015年02月09日

文件编写办法 1 目的 为规范体系文件的统一编制、标识及管理,达到编写体系文件规范化、标准化的目的,特制定本办法。 2 适用范围 适用于成渝钒钛科技有限公司所属各单位以及代管、托管单位所有文件资料的编制和审定。 3 内容及要求 3.1 手册的编写 3.1.1 手册的编写依据 以GB/T19001、GB/T19022、GB/T24001、GB/T28001标准以及国家有关法律、法规为依据,满足管理体系要求,并结合本公司实际,反映各项管理工作特色。 3.1.2 手册的格式 手册由手册封面、手册目录、手册章节、文件更改记录组成。 3.1.2.1 手册封面格式:见附录A。 3.1.2.2 手册目录格式:见附录B。 3.1.2.3 手册章节格式:手册章节(封面及刊头见附录C),每章节的内容应包括: a) 目的; b) 适用范围; c) 职责; d) 概要。 3.1.2.4 文件更改记录格式:见附录D。 3.2 程序文件的编写 3.2.1 程序文件的编写依据 依据成渝钒钛公司设置的管理模式、管理体系标准、国家有关的法律、法规、标准、规范及公司的方针、目标编写。 3.2.2 程序文件的编写要求 3.2.2.1程序文件是具体规定体系要求展开的各项活动的程序和方法,具体规定某项活动的目的和范围,应做什么,由谁来做,何时、何地和如何做,应使用什么材料、设备、方法和文件;以及如何对活动进行控制和记录等方面的内容。 3.2.2.2要注意各个程序文件上下左右的衔接,程序文件必须与管理手册规定的内容一

软件项目代码编码规范

变更履历

目录 1总则 (4) 2源代码完整性保障 (4) 3源代码的授权访问 (4) 4代码版本管理 (5) 4.1系统初验 (6) 4.2试运行 (6) 4.3系统终验 (7) 4.4系统验收标准 (7)

1总则 1、为保障公司源代码和开发文档安全不至于泄露,保证源代码的完整,明确源代码控制管理流程,特制定此管理办法。 2、本办法适用于所有涉及接触源代码的各部门各岗位。所涉及部门都必须严格执行本管理办法。 3、源代码直接控制管理部门为技术开发部。 4、本办法管理重点在于控制管理源代码的完整性,不被非授权获取,不被非授权复制和传播。 5、本办法所指源代码不仅限于公司开发人员自行编写实现功能的程序代码,而且还包括相应的开发设计文档及用于支撑整个系统运行所必须具备的第三方软件、控件和其它支撑库等文件。 2源代码完整性保障 1、所有软件的源代码文件及相应的开发设计文档均必须及时加入到指定的源代码服务器中的指定库中。 2、我们研发的产品软件运行所必须的第三方软件、控件和其它支撑库等文件也必须及时加入源代码服务器中指定的库中。 3、软件开始编写或者调整代码之前,其相应的设计文档和代码必须先从相应的SVN库进行SVNUpdate操作。软件编码或功能调整结束测试正确无误后,相应的源代码必须进行SVNCommit操作,在最终进行SVNCommit操作之前需要再进行SVNUpdate操作,查看是否有冲突产生,如果有冲突产生需要和冲突相关人一并解决冲突。 3源代码的授权访问 1、源代码服务器对于共享的SVN库的访问建立操作系统级的,基于身份和口令的访问授权。 第十条在SVN库中设置用户,并为不同用户分配不同的,适合工作的最小

公司文件编写管理规章制度

1. 目的: 为统一公司内部治理文件编写格式及编码规则,使其格式化、标准化,特制订 本治理方法,作为文件编写及编码的依据。 2. 范围: 2.1 本治理方法涵盖所有一、二、三级文件和质量记录表单的格式标准。包括:首页、内页、文件结构、段落章节等。 2.2 与产品相关的技术文件(图纸、作业指导书……),其编码依据“技术文件治理制度”中编写编码要求执行。 3. 职责 3.1 编写:各部门负责人依据工作需要,应指派专人负责编写某项作业流程的相关文件。 3.2 编号治理:编写文件人员必须向文件治理员取得文件的特定编号。

4. 定义: 5.程序 5.1 文件格式: 5.1.1 质量手册及程序文件首页格式参见附页2 1)修订号:0,1,2,3,4,5,每一份文件的任何一页修订5次以上则文件改版。假如文件一次性更改内容较多,能够看情况考虑换版。版次以A、B、C……依序编制,使用至Z版后,应重新发放,原有编号应作废不再使用。

2)文件版次变更后,将变更页次详细填写在首页制订/修订记录的页次栏内。 5.1.2 质量手册及程序文件首页,必须使用附页4,内页必须使用附页3特定的格式,并在每一页右上角标识文件编号、生效日期、版本号、修订号。 5.1.3不设首页的三级文件格式见附页5。 5.1.4质量记录表单的格式见附页6。 5.1.5文件封面见附页2。 5.2 文件结构:

1)总则 2)职责 3)操纵要求 4)相关文件 5.2.2 七/八段结构 1)目的 2)适用范围 3)职责 4)定义(适用时) 5)程序 6)相关文件 7)质量记录表单 8)附页(适用时) 5.3 文件编写结构讲明 5.3.1 目的 简述编写本程序的用途与宗旨。

项目编码规范编写指南

项目编码规范 1 命名规范 1).包名采用域后缀倒置的加上自定义的包名,采用小写字母。 在部门内部应该规划好包名的范围,防止产生冲突。部门内部产品使用部门的名称加上模块名称。产品线的产品使用产品的名称加上模块的名称。 格式: com.huawei.产品名.模块名称 com.huawei.部门名称. 项目名称 示例: Relay模块包名 com.huawei.msg.relay 通用日志模块包名 com.huawei.msg.log 2). 类名和接口使用类意义完整的英文描述,每个英文单词的首字母使用大写、其余字母使用小写的大小写混合法。 示例: OrderInformation, CustomerList, LogManager, LogConfig 3). 方法名使用类意义完整的英文描述:第一个单词的字母使用小写、剩余单词首字母大写其余字母小写的大小写混合法。 示例: private void calculateRate(); public void addNewOrder(); 4). 方法中,存取属性的方法采用setter 和 getter方法,动作方法采用动词和动宾结构。格式: get + 非布尔属性名() is + 布尔属性名() set + 属性名() 动词() 动词 + 宾语() 示例: public String getType(); public boolean isFinished(); public void setVisible(boolean); public void show();

public void addKeyListener(Listener); 5).属性名使用意义完整的英文描述:第一个单词的字母使用小写、剩余单词首字母大写其余字母小写的大小写混合法。属性名不能与方法名相同。 示例: private customerName; private orderNumber; private smpSession; 6). 常量名使用全大写的英文描述,英文单词之间用下划线分隔开,并且使用 final static 修饰。 示例: public final static int MAX_VALUE = 1000; public final static String DEFAULT_START_DATE = "2001-12-08"; 7). 属性名可以和公有方法参数相同,不能和局部变量相同,引用非静态成员变量时使用 this 引用,引用静态成员变量时使用类名引用。 示例: public class Person { private String name; private static List properties; public void setName (String name) { https://www.doczj.com/doc/fe16553209.html, = name; } public void setProperties (List properties) { Person.properties = properties; } } 8).如果函数名超过15 个字母,可采用以去掉元音字母的方法或者以行业内约定俗成的缩写方式缩写函数名。 示例: getCustomerInformation() 改为 getCustomerInfo() 2 程序注释规范 1)、基本注释(必须加)

编码规范以开发手册范本

1.软件开发手册 1.1.围 本标准规定了基于公司信息系统构建平台进行业务应用系统开发的编程格式规,主要包括命名规、代码注释、性能、以及常用语句的书写要求和约束等。统一规的格式有利于项目的交付和后续维护。 1.2.引言 1.1.1.简介 所有的程序开发手册都包含了各种规则。一些习惯自由程序的人(例如 Java 程序员)可能对这些规则很不适应,但是在多个开发人员共同协作的情况下,这些规则是必需的。这不仅仅是为了开发效率,而且也为了测试和后期维护。 良好的编码习惯有助于标准化程序的结构和编码风格,使源代码对于自己和别人都易读和易懂。在开发周期中越早使用恰当的编码规定,将会最大程度的提高项目的生产率。良好的编码习惯除了代码格式,详细的注释外,还应该包括使用有助于提高程序效率的编码方式。 规的开发有助于提高源码的可读性,可维护性,对于提高项目的整体效率更是不可缺少的(尤其是团队开发)。 1.1. 2.目的 本文是一套面向Java programmer 和Java developer进行开发所应遵循的开发规。按照此规来开发Java程序可带来以下益处: ●代码的编写保持一致性, ●提高代码的可读性和可维护性, ●在团队开发一个项目的情况下,程序员之间可代码共享, ●易于代码的回顾。 1.3.源程序 1.3.1.源程序命名 Java源程序的名字应该是这种形式:ClassOrInterfaceName.java。ClassOrInterfaceName 应该是在Java源程序中定义的 class或者interface的名字(关于classes和interface的命

名规请参考3.2)。源程序的文件名后缀通常为.java。 1.3. 2.供发布的文件 如果文件编译后,需要用打包的形式发布,那么这个包的名字应该是有代表性的(例如应该是这个模块或者这个文件所在单元的名字)。通常包的扩展名有 *.jar(推荐使用)或者 *.zip、*.ear、*.war等。 1.3.3.源文件的组织 一个Java源文件应该包含如下的元素,并按照以下顺序书写: 1)版本信息和声明 2)包的声明 3)引用声明 4)类或者接口的声明 以上元素之间以至少一个空行来分隔。 1.3.3.1.版本信息和声明 每一个源程序应该以一个包含版本信息和声明的块为开始。 例如: /** * application name: sample1 * application describing: this class handels the request of the client * copyright: Copyright ? 2002 金质工程所有 * company: neusoft * time: 2002.02.25 * * author Brunce * version ver 3.1 */

文件编号管理规定

文件编号管理规定文件编码(008-TTIG-UTITD-GKBTT-PUUTI-WYTUI-8256)

文件编号管理规定 一、目的 为了规范各部门和各管理体系文件的编号及文件的日常管理工作,使文件在使用过程中不发生内容重复、遗留,便于文件的检索和存档,特制定本办法。 二、适用范围 适用于君霖纺织所有文件&制度的编号。 三、术语 根据文件性质分为体系文件、技术文件、合同文件、文书文件四类。 1、体系文件指质量手册、程序文件、管理文件、管理通知、质量记录等与质量体系有关的文件。 2、技术文件指产品技术文件、工艺技术文件、检验技术文件、外来技术文件和其它技术文件五大类。 3、合同文件指中标通知书、专用合同条款、通用合同条款、经合同双方确认进入合同的其他文件。 4、文书文件指公司行政文件、行政规章、各种请示、一次性的通知等其它与质量体系无直接关联的文件。 四、职责 1、办公室负责体系文件、技术文件的编号和归口管理。 2、人力资源部负责文书文件的编号和归口管理。

3、财务部负责合同文件的编号和归口管理。 五、正文 1、文件编号规则 外来文件执行原编号。 体系文件根据体系文件编号规则进行编号,例:JLFZ-QM-1701。 技术文件根据技术文件编号规则进行编号,例:JLFZ-JS-1701。 合同文件根据合同文件编号规则进行编号,例:JLFZ-RZ-1701。 文书文件根据文书文件编号规则进行编号,例:JLFZ-CW-1701。 2、文件编写规范 文件分为标题→编号→目的→适用范围→术语→职责→正文→接口文件→记录→附则等十部分(严格执行以上编写顺序),可依据文件性质进行适当删减。 体系文件编写规范(见附件一) 技术文件根据技术文件编写规范进行编写。 合同文件根据合同文件编写规范进行编写。 文书文件编写规范 红头文件编写规范(见附件二) 报告/请示编写规范(见附件三) 会议纪要编写规范(见附件四) 一般性通知编写规范(见附件五) 通报编写规范(见附件六) 六、附则 本办法从2017年4月10日开始执行。 本办法的解释权归办公室。

项目开发及编码规范

项目开发规范文档修订历史记录

1.简介 目的 1、用于规范指导开发组进行开发 2、便于成员间的沟通与交流。 3、有助于项目质量和稳定。 4、为后期维护提供支持 2. 项目开发流程 项目开发过程归纳分为以下步骤: 1. 建立SVN项目版本控制。包括文档,源码,Lib包等。 2. 了解需求,并对需求文档的书写。(见文档结构规则附录)。 3. 详细设计文档。(见文档结构规则附录)。 功能模块设计,重要模块的算法设计。 数据库设计等。 根据需求定义开发平台及环境。 4. 编码。 搭建开发平台,配置开发环境。 编码。 单元测试案例。 5. 书写软件安装手册文件,数据库脚本文件,以及注意事项(release notes)。 6. 交互测试组测试。根据测试组测试结果是否回归第4步(测试回归最好不要超过2 次)。 7. 测试通过,交付上线使用。 维护手册 使用手册

3. 代码规范 Java 代码规范 3.1.1 Java类名 类名可由:英文字母,数字,下划线组成。(数字,下划线不能够开头) 类名由一个或者多个单词组成。单词通常要求简洁明了达意。能够通过类名能够大致了解此类的作用和用途。 类名要求首字母大写,多个单词组成类名时,单词的首字母要求大写。 建议:类名不要过于简单或者太长。可以对单词采用简化的名称:入: Number 简化为:num 。 3.1.2 Java类结构 类仅作为数据结构,没有行为,他封装了一组或者相似的一些行为方法。所以一个类尽量功能单一,或者功能类似共有行为的。一个类不要过于庞大。 通常情况下: 一般逻辑类中应该有构造方法和main方法,main方法中应该有测试代码。 每个类应该有 toString() 方法。 3.1.2.1 包和引入语句 在多数Java源文件中,第一个非注释行是包语句。在它之后可以跟引入语句。 报名的定义全部是小写字母。具体定义依据项目而定。 引入包时候,同一类型的归纳到一块,用空行隔开。例如: import 3.1.2 类注释 Java类开头应该有相应的注释:类版本描述,作者签名,日期时间,公司备注,类的功能作用相关描述等。(详细查看:注释) 3.1.2.2 类成员变量 a) 类变量要求放在类的开始声明。一行声明一个。 b) 变量名称首字母要求小写。其他命名规则类似与类名。 c) static , final 类型的变量,字母要求全部大写。 d) 尽量在声明局部变量的同时初始化。 e) 避免局部变量和成员变量同名,覆盖了成员变量。 f) 尽量变量私有化,缩小变量的作用域。 3.1.2.3 类成员方法 a) 方法名命名规则类似于成员变量命名规则。 b) 成员方法尽量私有化。

文件编号及格式管理制度

文件编号及格式管理制度 1. 目的 确定文件的编号规则是为了使文件有分类标准,以便全公司内统一,便于区分、传递、查找和存档。 2. 适用范围 适用于天津市屹马汽车配件制造有限公司所有部门的行政文件、工艺技术文件、质量管理体系文件。 3. 术语和定义 无 4. 职责与权限 4.1 总务人事部负责行政文件编号规则的制定和管理; 4.2 质检部负责公司总体质量管理体系文件编写规则的制定和管理; 4.3 各部门负责本部门文件编号的正确运用。 5. 工作程序 5.1代号说明 5.1.1公司及部门代号说明 代号由两位字母组成,其代号规定见下表:

5.1.2文件类别代号说明 如有其他类型的文件应取拼音字母前两个。 5.2文件编号及识别号编制规则 5.2.1行政文件编号规则参照总务人事部下发的《行政文件编制规则》进行,其中各部门代码按照本规 定5.1.1执行。 522体系文件编号编制规则 5.221体系文件编号构成如下: 5.2.2.2 体系文件编号说明 a ) 体:代表质量管理体系文件 b ) 文件类别:X 代表I-V 类文件夹,也就是IS09001标准4.2.1条款a )-e )类文件,用a-e 书写(a 代 表质量方针、质量目标。 B 代表质量手册. c 代表程序文件. d 代表支持文件. e 代表记录、表单) c ) TYM 天津屹马汽车配件制造有限公司 d ) XX ISO/TS16949 : 2009 标准条款 e ) XX 文件序号,从 01-99 5.2.3体系文件识别号编制规则 5.2.3.1公司级体系文件识别号构成如下: 文件序号 过程条款 文件类别 体系文件缩写 企业代号

文件编号管理规定

Date:14/07/01 文件版本A/0 Page 1/2 1.目的:为规范公司文件、表格的编写、修订、审批和管理流程,以确保文件的规范化和系统化,满足管理要求。 2.定义 文件分类:公司文件分可控文件和非可控文件二大体系, 可控文件按四级管理 2.1一级文件:管理手册;简述本品质系统如何满足国际标准要求。代号用QM表示 2.2二级文件:程序文件;规定何人,于何时,在什么地方做什么事。代号用QP表示 2.3三级文件:作业文件,包括工作指示或流程、作业指导书、车间管理办法、仓库管理办法、文件和资料编写导则、产品标识细则等,用WI表示 2.4四级文件:表单、记录,用以收集数据,传递信息,控制作业流程或证明及作业流程执行所留下的记录.代号用QR表示 非可控文件分外来文件、其他行政管理公司发文及公司协议、技术资料等等。 2.5公司各部分代号如下: 行政部---XZ 财务部---CW 办公室---BG 采购部---CG 生产部---SC 扣带部---KD 包装部---BZ 打磨部---DM 收发中心---SF 开料机---KL 钻床部---ZC 锣床部—LC 啤压部—BY 数控机床—CNC 工模部—GM 电加工—DJ 后勤部—HQ 例如三级文件—图纸管理规定 文件表头可设置为 图纸管理规定WI-JS-01 Date:14/07/01 文件版本A/0 Page 1/1 3.管理程序 3.1第一级文件(QM)编写 管理体系手册由管理者代表或管理者代表组织编写,手册的格式不固定,但必须符合如下的要求: a、手册要参考ISO9001《质量管理体系要求》和ISO14001《环境管理体系要求及使用指南》编制; b、手册的编号为QM,由文控员进行统一编号。 c、手册有版本和生效日期的控制,其首次版本为A/0版,生效日期为手册发行日期; d、手册中使用的公司名称必须与注册名称相同; 3.2 第二级文件(QP)编写 程序文件(QP)的编写 程序文件由相关的文控员负责组织编写。必须符合如下要求:

文件编号管理办法

文件编号管理办法 1.目的 为规范公司各类文件的管理,统一各类文件的编号,确保在需要时能及时得到适用文件的有效版本,特制订本办法。 2.适用范围 本办法适用于公司各中心、部室发放的各类文件及外来文件的编号,具体包括以下几类: (1)质量、环境及职业健康安全管理手册; (2)作业程序文件:指对公司各类管理事务的工作流程所作的基本描述和规定; (3)管理制度:指对公司的基本组织规程和各领域的工作所作的基本规定; (4)记录表单:指在公司工作中所使用的表格、单据; (5)图纸:指有关公司土建、水电安装、网络等图纸; (6)外来文件:指各级政府部门、客户、供应商等外部往来单位的来文。 通知、通报、联系函等不适用于本办法。 3.职责 办公室负责公司各类文件编号规则的制定及编号分配。 4.内容和要求 4.1编号构成 4.2.1质量、环境及职业健康安全管理手册 YC—GLSC—XXXX 编写年度代码 管理手册代码 公司代码 4.2.2作业程序文件 YC/CX—XX—XXXX 编写年度代码 章节代码 程序简称 公司代码 4.2.3管理制度

YC/ZD—XXXX—XX—XXXX 制定年度代码 流水编号 前两位为类别代码,后两位为细类编号 制度简称 公司代码

4.2.4记录表单 YC/BD—XX—XX—XXXX 年度代码 流水编号 部门代码 表单简称 公司代码 4.2.5图纸 YC/TZ—XX—XX—XXXX 年度代码 流水编号 类别代码 图纸简称 公司代码 4.2.6外来文件 YC/WL—XXX—XXXX 年度代码

流水编号 外来文件简称 公司代码 4.2.7公司其他发文,按照公司《文件管理办法》的规定进行编号。 4.3本办法由办公室负责制定、解释和修改,各子公司文件由各子公司参照本办法自行编号。 4.4本办法自总经理批准之日起执行。

项目管理的编码规则

附录 1项目管理编码方案 1.1项目分类 1.1.1编码规则 项目分类采用两层两位字符组合码,1~9加上A~Z(E、I、O及特殊字符除外)。 1.1.2代码表

1.1.3编制说明

项目分类参考了现行的项目分类代码标准。同时在大修、科技项目分类中还参考了《国家电网公司设备大修工作管理办法(试行)》、《国家电网公司技术改造工作管理办法(试行)》相关项目类型的定义及规定。 目前国家电网公司以及各网省公司还保留着部分抽水蓄能电厂以及用于调峰调频、调峰填谷的电厂,为满足这些电力工程的管理需要,在项目分类“基建项目”类中保留了“电源项目”类。 1.2项目编号 1.2.1基建、技改类项目编码规则 1.2.1.1编码规则 项目编号采用4层10位代码结构。 表中: ?N标识该位为数字代码;X标识该位为数字+字母的混合代码。 ?项目类别引用项目类型列表中的2位分类代码。 ?第3、4位代表项目申请单位所属的网省公司,用两位数字标识,直接 引用《国家电网公司直属单位代码》(《国家电网公司直属单位代码》 见人力资源管理编码方案5.1 国家电网公司直属单位代码。)。 ?第5、6位代表项目申请单位,以两位字符标识,由各省自行定义。 ?第7、8、9、10位代表项目编号,以四位字符标识。项目编号流水号允 许实施过程中增加自定义属性信息。 ?项目编号中,当前面代码元素中的一个层次发生变化时,项目编号需重 新开始编号。 1.2.1.2编制说明 基建、技改类项目的项目代码结构包括“项目小类”、“网省公司代码”、“申请单位代码”和“项目编号”四个部分。 与大修、科技、营销类项目编码方案相比,本方案中不包含“立项申请年度”。关于年度问题,编码组讨论了“项目申请年度”、“立项批准年度”等不同的时间点,若采用“项目申请年度”,则从做项目滚动规划到项目申请这之间的时间内,就不能赋予项目相应的编号;若采用“项目申请书编制年度”或“项目开工时间”,也存在同样的问题;采用“立项批准年度”,因有些项目有时会在开

项目编码规范

项目编码规范 (一)命名规范 Java包、类的命名应尽量采用完整的英文描述符,一般采用小写英文字母,但类名、接口名以及任何非初始单词的第一个字母要大写,不能用完整英文描述的,应以该英文单词的前四个字母或能代表单词意思的缩写代替。具体如下: (1)尽量使用完整的英文描述符; (2)采用合适于相关领域的术语 (3)采用大小写混合使名字可读 (4)尽量少用缩写,确有需要的,要能表达其意义; (5)避免使用长的名字(小于15个字母) (6)避免使用类似的名字,或者是大小写不同的名字; (7)避免使用下划线(除静态常量等); 举例如下: 包(packge) 采用完整的英文描述符,应该都是由小写字母组成。对于全局包,将你的internet域名反转并接上包名。如:com.boyi.eim,com.boyi.oa.web 类(Class) 采用完整的英文描述符,所有单词的第一个字母大写。如:User,StuManager 接口(interface) 采用完整的英文描述符说明接口封装,所有单词第一个字母大写。名字后面加上后缀Dao,实体类实现接口加上后缀Impl 类变量:采用完整的英文描述符,第一个字母小写,后所有单词的第一个字母大写。如:userName 参数:同上 获取成员函数:封装字段,被访问时调用get set方法 普通成员函数:采用完整的英文描述符,第一个字母小写,后所有单词的第一个字母大写。 静态常量字段:全部采用大写字母,单词之间用下划线分隔。 循环计数器:通常采用字母I,j,k…………….. 数组:采用完整的英文描述符,第一个字母小写,后所有单词的第一个字母大写 (二)代码注释 良好的注释习惯对于一支程序来说,是其易于解读的关键。也就是说,如果另一个编程人员从未见过这段代码,要在合理的时间内理解代码,需要知道哪些信息。并以此作为注释的依据。因此对于注释来说,需要注意以下几点: (1)注释应该增加代码的清晰度; (2)保持注释的简洁; (3)在写代码之前写注释 (4)注释出为什么做了一些事,而不仅仅是做了什么 使用代码注释的目的: (1)文字说明代码的作用(即为什么要用编写该代码,而不是如何编写); (2)确指出该代码的编写思路和逻辑方法; (3)人们注意到代码中的重要转折点; (4)使代码的阅读者不必在他们的头脑中仿真运行代码的执行方法. 代码注释原则: 1. 用文字说明代码的作用:简单的重复代码做写什么,这样的注释几乎不能给注释增加什么信息.如果你使用好的命名方法来创建直观明 了的代码那么这些类型的注释绝对增加不了什么信息. 2. 如果你想违背好的编程原则,请说明为什么:有的时候你可能需要违背好的编程原则,或者使用了某些不正规的方法,.遇到这种情况 时,请用内部注释来说明你在做什么和为什么要这样做。技巧性特别高的代码段,一定要加详细的注释,不要让其他开发人员花很长时间来研究一个高技巧但不易理解的程序段。 3. 用注释来说明何时可能出错和为什么出错 4. 在编写代码前进行注释:给代码加注释的方法之一是在编写一个方法前首先写上注释.如果你愿意,可以编写完整句子的注释或伪代码.

相关主题
文本预览
相关文档 最新文档