代码编写规范说明书

代码编写规范说明书（精选4篇）

代码编写规范说明书 篇1

1、所有代码排版整齐，可以使用编程工具自带的排版功能；

2、代码缩进使用Tab键，不允许使用空格；

3、标示符的声明：修饰符与变量名之间留一空格；

4、用途相近的变量声明之间不加空行；用途相差很远的变量声明之间加一空行进行区分；

5、变量声明要集中，不允许分散在程序代码之间；

6、对于语意不明确的变量名要增加注释进行说明；

7、对于方法功能要进行注释说明；

对于功能非常简单的，并且可以直接从方法名称推断出其具体功能的方法，可以不加注释；

所有的方法注释必须准确；

8、方法的排列顺序要依照功能的排列顺序进行排列；

9、CSS样式代码编写顺序需要按照页面的排版顺序进行排列，不同的组件样式之间要以明显的“分隔符”进行分隔；

10、Html代码排版一定要规范，按照不同标签的层次关系进行适当的缩进排列，缩进使用Tab键，不允许使用空格；

11、Java代码的编写，首先进行变量声明，接下来是构造方法，在接下来是一些其他的功能方法，最后是变量的get/set方法。如果有嵌入类或嵌入接口的声明，应该放在文件最后，且需要增加注释详细说明；

代码编写规范说明书 篇2

1 标识符命名的规范

C是一种简洁的语言,那么它的命名也应该是简洁的。比较著名的命名规则有以下三种:匈牙利命名法,即标识符的名字用一个或多个小写字母打头,其后是能体现变量用途的首字母大写的一个单词或多个单词组合,例如get Elenment。骆驼(Camel)命名法,即第一个单词首字母小写,余下的单词首字母大写,例如clear Interval。帕斯科(Pascal)命名法即第一个单词首字母大写,例如First Child。

1.1变量定义

在定义变量时,前缀使用变量的类型,之后使用体现变量用途的英文单词或单词缩写,且每个单词或缩写的首字母大写,各种前缀缩写如下:

1.2 宏定义

宏和符号常量都要大写,单词之间用‘_’分隔,例如:

#define MAX_HIGHT 25

1.3 函数的命名

函数名一般使用下划线分割小写字母的方式命名,例如:

2 大括号的位置、缩进和空格空行的规范

每个结构体的定义,数组的初始化,枚举类型的定义,以及if,for,do,while,switch case等均会用到{}。 它是程序块的分界符,必须同时存在。大括号的作用是把若干条语句捆绑在一起,形成一个语句块,要执行都执行,要不执行都不执行。一行程序的开始习惯空四个字符,对齐用tab,这样能避免用不同的编辑工具打开时出现代码混乱。例如:

3 注释规范

注释有助于对程序的阅读理解,在该加的地方加,不宜过多也不能过少,其语言必须简洁易懂。通常情况下注释是说明代码做些什么,而不是如何去做。以下是一个函数开始部分的注释示例:

4 运算符与表达式的规范

C语言有40 多个运算符,结合性有左结合和右结合,优先级也各不相同。这就造成了c表达式的多样性和复杂性,经常会出现一些容易使人搞混的问题。因此,为了降低表达式的出错概率,应该多使用括号明确表达式的操作顺序。例如在回文数的判断中,有如下代码

因为“=”优先级别低,我们强制加上括号保证优先进行计算。

5 指针的规范

C语言中如果没有指针,C程序将变得低效难懂,因为你无法在任何子函数中修改一个结构体的内容,这种程序类似于无状态程序。指针的使用如果指向了垃圾内存,也是相当危险的。指针的数据类型如下表所示:

6 结束语

C语言作为一门学习计算机的基础学科,初学者要掌握学习方法,要注意学习编程的风格,便于培养良好的习惯。良好得编程风格是减少错误的最有效方法。作为教师应该有这样的责任感,可将编程的规范纳入到考核的范畴,引起学生的足够重视,规范学生书写代码的习惯。

参考文献

[1]小红,惠鹏,志岗.C语言学实用教程[M].北京:电子工业出版社,2005.

[2]杨静,王浩,方宝富,等.程序设计课程教学改革探讨[J].吉林大学学报:信息科学版,2005(8):7-10.

代码编写规范说明书 篇3

其中定义了一个输入变量 YES_OR_NO,

按照脚本定义的规则，当其值等于yes,则输出,

you input:yes

U r a sea man!welcome you!

当其值等于no,其值为

you input no

U r not a sea man,please exit this system

但是当脚本编写后，给脚本赋予可执行权限并编译

执行后输入结果yes

屏幕输出结果如下:

没有得到想要的结果，在第4行报错，

关于shell脚本编写代码格式的一个细节

，

考虑到有可能是条件格式的问题，因此将条件前后各个变量与括号用空格隔开如下：

编译执行后

yes

www.dnzg.cn

输入no测试

返回的还是yes的值。

所以最后，将条件格式更改为:

输入no，输出结果为:

输入yes，输出结果为

搞定，成功!

通过这个例子说明，在编写shell脚本的过程中，各个变量以及常量和描述的间距及整体的格式有时候也非常讲究，如果不注意，可能会影响程序的运行，而造成不必要的纠错开销。

浅析职位说明书的编写 篇4

摘要：随着企业的发展，员工越来越多，业务分工更加细化，领导仅凭工作经验安排工作已不适应企业发展需要。为了让企业更好的发展，让员工知道自己该干什么，什么时候干，理顺企业管理，明确各岗位职责是非常必要的。现就根据企业在编写职位说明书中普遍存在的问题，提出职位说明书编写过程容易出现的问题及如何正确编写职位说明书的建议。

关键词：职位说明书；问题；建议

职位说明书是关于工作执行者实际做什么、如何做、在什么条件下做的一种书面文件。这种信息又可用来编写工作规范以说明执行人为了圆满完成工作必备的知识能力和技术。当前我国很多公司对职位说明书的编写不够重视，同时也没有规范的管理制度，没有部门职责分工，员工没有明确岗位职责和上岗条件，领导随心所欲安排人员，不考虑实际工作开展，长此以往会影响企业正常管理。现根据实际情况，作如下分析：

目前企业在编写职位说明书时普遍存在的问题：

一、单纯的为编而编为写而写

在部分企业当中，由于领导间职责分工不明确，谁有空谁多管的行为导致了管理混乱和随意性，各部门间经常出现推诿扯皮等问题部分企业只关注了职位说明书的有或无，使得职位说明书流程不清，员工操作困难，形同虚设。实际上，职位说明书的内容，应该侧重于工作分析的过程，让员工知道怎么做，把编写职位说明书作为企业现有岗位的一次盘点，或者说是一次业务流程的重组，从而明确各岗位的职责与权限，规范业务流程，以实现提升管理水平的目的。

二、未对工作人员开展专业培训

职位说明书编写工作是人力资源管理工作中的一项专业技术工作，是一项专业要求非常高的工作，大部分企业都缺乏对参与该项工作人员的专业培训，所以编写出来的职位说明书存在大量表述不准的情况特别是岗位的概述职责工作能

力要求基本技能要求等描述不准确。比如笼统地使用“负责、全面负责、相关工作、管理、提高、完成”等模糊概念的词语，造成职位不同但职位说明书的描述却很相近，使相近岗位间无法明确自己的准确职责。

三、对编写工作认识不到位

职位说明书的编写应是一个自上而下的过程，涉及到企业管理的各个环节，编写职位说明书的目的是要使员工明确自己的工作职责、上岗要求、技能要求、各岗位的上下级关系等。所以，在编制职位说明书时应得到全体员工的支持、参与和理解。但在实际中，不少企业在开展这项工作时并没有与员工充分交流，让员工充分参与，所以作用不大。

四、定位不准确

当前，在很多企业都能找出多样式的职位说明书，但细读后你就会发现，这些并不是职位说明书而仅仅是岗位职责。岗位职责侧重于岗位任职者应该完成的任务，并不能全面反映岗位的信息，并没有具体行为或工作活动的结果职位说明书则可以全面反映岗位职责、工作经验要求、工作能力要求、基本技能要求、岗位协调等相关信息。

五、职责与任务交叉

为了把工作任务完成得更好，提高企业的竞 争能力，许多企业就以具体的工作设计，即公司的某项工作任务，需要多个部门或多个岗位共同协助完成，就把多个部门和岗位的员工抽调到一起共同完成某项工作，这就形成了职责交叉。正确处理好职责交叉有助于发挥协作效应，取长补短，提高工作效率。但很多企业在撰写职位说明书时，对某些职责与任务交叉的工作没有明确或者不清楚，造成工作中岗位职责不清，领导多多，员工不知道该听谁指挥，一但出现问题各部门岗位之间就会互相推诿扯皮，大大降低了工作效率。

六、职责重叠，不区分细节

在企业中，一些工作任务性质相同或相近，工作量非常大，在岗位设置时就会出现“一岗多人”的现象。在进行岗位描述时，很多企业一般都采取了同一类设置一个岗位，归纳总结出该岗位的共同特征，定义出岗位的共性要求，就此编写了一份具有放之四海而皆准的职位说明书，却忽视了该岗位的不同任职者之间工作任务的差别，导致职位描述不准确。

七、脱离实际，结果束之高阁

在实际的管理过程中，较多的企业已经认识到职位说明书的作用，较好地开展了工作分析、职责分类，但编写出来的职位说明书却并没有发挥应有的作用。不少企业对工作分析缺乏正确的认识，觉得其他企业因开展这项工作而提高了企业管理水平，所以就盲目地随大流；有的企业由人力资源部门独家“打造”每个岗位的说明书，脱离企业实际状况时有发生。尤其是对任职者资格的界定没有明确的标准，结果职位说明书无法在实际工作中应用，成为企业的“文物”。

八、缺乏系统思考

职位说明书编写的过程，是对企业管理流程的一次重新认识。一套成体系的职位说明书，可以给企业的各项管理工作特别是人力资源管理工作提供重要依据。但是，很多企业的职位说明书中对职位的描述不准确，要么夸大职责、要么缩小职责、要么就归纳不完整，任职资格因人而定，不具有统一的、客观的标准；还有的企业为节约经费，只对重要岗位进行说明书编写，造成后继岗位评价、岗位培训、岗位薪酬、人员招聘、职业生涯规划等工作缺乏统一的标准，造成缺胳膊少腿现象。

那么，如何才能编写出一份高水准职位说明书呢，在此仅给一些建议：

一、领导重视，统一认识

在开展职位说明书编写工作之前，人力资源部负责人一定要先和公司相关高层领导进行讨论，明确此次工作的目的，明确规范岗位职责对公司管理的意义，让领导层统一思想，正确认识职位说明书编写工作对企业管理的作用，取得领导对职位说明书“规范”工作的理解与支持，并保证在职位说明书的编写过程中，高层领导先作表帅，对相关工作实行归口管理，改变原来随意性较大的管理方式。

二、加强培训，提高技能和认识

编写职位说明书之前，人力资源部门首先要做好工作计划，开展业务培训，为各个部门开展编写职位说明书工作做好技术支撑。同时，要做好充分的编写准备工作，培训会上给员工宣讲制定职位说明书的目的和意义，职位说明书中各个项目的作用，让员工从思想上重视该项工作。

三、统一尺度，规范要求

在职位说明书中对每位任职者的资格，必须对全公司所有岗位提出一个最基本要求。比如，公司可以将生产类员工的最低要求定为：学历必须是大专及以上，技能必须中级工及以上，有同行业三年及以上从业经验；管理类可以要求最低学历为本科及以上，职称为助理及以上，从事过两年以上管理工作经验等。在实际操作时只能高于这个标准，对于一些特殊岗位，可以要求是中共党员，驾龄三年等。只有这样，编写出来的职位说明书才不会因人设岗，具有广泛的适用性。

四、分层实施，做到不缺不漏

岗位职责应该是部门职责的分解，部门各项职责应在岗位职责中得以体现，即“千斤重担人人挑，人人肩上有指标”。部门职责是界定岗位职责的基础，因此，界定岗位职责的前提是明确部门职责。在编写职位说明书之前，必须先明确部门职责，再对现有人员工作进行认真的分析。在实际操作中，可以选用报表收集数据、面谈法、工作写实、实地观察等方法取得一线真实资料。根据任务量和工作的具体要求，将各部门的工作任务合理地分解到具体的岗位，确定部门内各岗位的职责，防止工作中扯皮现象的发生，从而提高工作效率。

五、用语要规范

在编写职位说明书的过程中，使用规范的描述方式和用语直接关系到职位说明书的质量，因此，必须高度重视。标准的岗位职责描述格式应是“动词+宾语+结果”。动词的选择可参照岗位职责动词使用规范表，如：主持、制定、组织、执行、策划等等；宾语表示该项任务的对象，即工作任务的内容，结果表示通过此项工作的完成要实现的目标，可用“确保、全面完成、争取、促进”等等，以保证职位说明书的写作规范。

六、完善管理机制

（一）是完善审核机制。各位员工完成职位说明书编写后，首先由部门负责人进行审核，审核完成后交由分管领导审核，最后由公司领导审核。

（二）是完善群众监督机制。将审核完成的职位说明书通过公示的方法，让群众对职位说明书提出意见，同时让更多的员工了解那项具体的工作应该由谁管理，也给群众办事提供方便。

（三）是动态管理机制。职位说明书编写工作相当重要，企业的发展会对职位提出新的要求。因此，企业编写出规范的岗位说明书后，人力资源部门应建立

岗位说明书的动态管理系统，在规定时间内由专职人员组织修订。

参考文献：

（1）加里·德斯勒；人力资源管理（第9版）；2008年5月第5次印刷。