代码设计时应遵循哪些原则

1提高编码质量，代码可读性和可维护性。

2代码编写规范

21 删除所有无用代码

22 必须给代码添加注释，一个类的注释字数不得小于代码的百分之20%

23 建议遵循30秒原则。如果另一个程序员无法在三十秒内无法知道你的函数在做什么，如何做以及为什么要这样做，那么说明你的代码是难于维护的，需要得到提高。

24 一个函数的代码长度不允许超过100行，超过一百行的函数建议在不破坏原子性的基础上进行拆分。

25 变量都应在方法或者类的头部集中定义

26 保证一行代码只做一件事

27 使用括号来控制 *** 作符的运算顺序，以免使用java默认的 *** 作符优先级顺序。

28 代码格式化：对代码进行格式化，再进行提交。

29 接口不允许没有方法或者变量的声明

3 命名规范

31 各种标识符的命名要使用有实际意义的英文单词或者英文单词缩写，缩写词及英文单词要收录在项目的简写词汇表中。切忌使用阿拉伯数字和拼音进行命名。

32 类名：首字母大写，每个单词首字母都需要大写。

33 方法名：首字母小写，其余单词首字母都需大写。

34 全局变量，和常量名称要求全部字母大写。

35 参数名称与局部变量基本相同，区别在于参数名称需要加上冠词a ，an 或者在单词结尾以s结束。

4 注释规范

41 注释需要注意的事项：

★注释应该用中文清晰表达意思，应该是程序看起来更清晰，更容易理解

★注释要尽量简明，避免装饰性的注释。

★注释不但要说明做什么，还应当说明为什么要这样做。最好先写注释表明要做什么，再进行编码。

42 类的注释

★类的用途，目的。包括其他人感兴趣的介绍。

★已知bug,当然最好是修改好所有的错误，但有时可能暂时没有办法修改，或者没有时间修改。

★开发和维护该类的历史列表，记录每一次修改的作者，日期，修改的内容。

★列举类的各种稳定状态，说明调用成员函数使类的状态产生的变迁(可选)。

★同步问题（可选）

★对主要的算法必须加以说明，主要流程必须给予引导性说明

标准格式：

如果对已经版本话的类进行了修改，需要按照如下格式为每一次修改附加修改历史记录：

// 修改人 + 修改日期

// 修改说明 范例：

// 李四 2010/07/02

// 添加错误数据修改后继续批量保存的处理函数 saveBatch(

@Bind(key = "itemParams", defaultValue = "") String itemParams,

@Bind(key = "pid", defaultValue = "") String pid)。

// 王小二 2010/07/02

43 接口注释：

★接口的注释风格基本与类的注释风格相同；

★在别人使用接口之前，必须了解接口所包含的概念。检验一个接口是否应该定义的简单方法是：你是否能★够容易的描述接口的用途；

★接口如何应当和不应当被使用。开发者需要知道该接口如何被使用，也希望知道该接口不能被怎样使用。

44 函数的注释

★函数头注释必须包括：函数执行了什么功能，为什么要这样处理；函数处理过程中对对象的哪些属性

★可能进行更改；函数执行前后，对象的状态；

★比较、循环等控制结构加注释（可选）；

★在代码的功能并非一目了然的情况下，应当说明为什么要这样做；

★局部变量必须加注释；

★复杂难写的代码必须加注释；

45类属性的注释:

★描述域的用途。使别人知道如何去使用它；

★对于有着复杂事物规则的域，可以加入范例来说明。有时候一个简单的小例子，抵的上千言万语；

代码不规范，如果你离职了，将来维护的人看起来比较艰涩难懂，维护起来比较困难。

让系统瘫痪，程序中断不是规范引起的，是你的代码逻辑引起的。

如果程序无法运行，重新启动未必可以，要看是不是致命逻辑错误。如果是逻辑错误，重启N次都是一样的。

代码不规范和代码错误是两回事。代码错误才会引起你说的那些错误，代码不规范是正确的，按时不利于团队之间维护和后期管理而已。

软件著作权源程序代码是必备的重要材料之一，所以对提交的代码文件规范格式有着严格的要求。按照以下要求来提交，基本上就没问题：软件著作权源代码撰写1、代码要求提供原始代码，不能使关键代码，语法要求完整，例如C++代码应该是include之类开头的，C#代码应该是using之类开头的，不能直接就是函数2、代码量（不含纯空白行）不足3000行的，提供完整代码3、代码量（不含纯空白行）超过3000行的，提交前后30页（至少3500行）4、格式要求：（1）代码字号不能大于13，除第60页外，每页不少于50行，纯空白行不算；（2）包含人名、地址、时间、版权的注释全部删掉，大段描述性的注释删掉；（3）第1页第1行必须是软件或模块开头，第60页最后一行必须是软件或模块结尾。（4）源程序须添加页眉，页眉处务必写清软件的名称（与全称或简称一致）及版本号软件著作权源程序代码文件格式要求严格，往往因为一些小小的细节就需要进行补正，找八戒知识产权专业的软件著作权代理人团队可以提供更为保障的服务，又节省精力和时间。

C语言源代码，就是依据C语言规则所写出的程序代码，常见的存储文件扩展名为c文件和h文件，分别对应C源文件(source file)和C头文件(header file)。

C语言是一门编程语言，简单点说，就是由人类书写按照一定规范书写的字符，通过一定手段（编译链接）转换后，可以让电脑或者其它电子芯片＂读懂＂，并按照其要求工作的语言。在所有的编程语言中，C语言是相对古老而原始的，同时也是在同类语言中更接近硬件，最为高效的编程语言。

相关内容：

C语言是一门面向过程的计算机编程语言，与C++、C#、Java等面向对象编程语言有所不同。C语言的设计目标是提供一种能以简易的方式编译、处理低级存储器、仅产生少量的机器码以及不需要任何运行环境支持便能运行的编程语言。

C语言描述问题比汇编语言迅速、工作量小、可读性好、易于调试、修改和移植，而代码质量与汇编语言相当。C语言一般只比汇编语言代码生成的目标程序效率低10%-20%。因此，C语言可以编写系统软件。

当前阶段，在编程领域中，C语言的运用非常之多，它兼顾了高级语言和汇编语言的优点，相较于其它编程语言具有较大优势。计算机系统设计以及应用程序编写是C语言应用的两大领域。同时，C语言的普适较强，在许多计算机 *** 作系统中都能够得到适用，且效率显著。

C语言拥有经过了漫长发展历史的完整的理论体系，在编程语言中具有举足轻重的地位。

功能要求

为Python代码添加注释，对Python程序代码进行说明。

实例代码

'''多行注释开始

下面的代码根据变量x的值计算y

注意代码中使用缩进表示代码块

多行注释结束'''

x = 5

if x > 100:

y = x 5 - 1 # 单行注释：x>100时执行该语句

else:

y = 0 # x <= 100时执行该语句

print(y) # 输出y

运行结果

知识说明

注释用于为程序添加说明性的文字，帮助程序员更好的阅读和理解程序代码。Python解释器会忽略注释的内容，即注释的内容不会被Python解释器执行。

Python注释分为单行注释和多行注释。

单行注释以符号“#”开始，当前行中符号“#”及其后的内容为注释语句。单行注释可以独占一行，也可放在语句末尾。 说明： 在Pycharm中使用“ctrl + /”可以添加/取消单行注释。

多行注释是用3个英文单引号“'''多行注释文本'''”或3个双引号“"""注释文本"""”进行注释。 注意： 由一对三个单引号或一对三个双引号括起来的内容被认为是注释，但不能由三个单引号和三个双引号混合使用。

以上就是关于代码设计时应遵循哪些原则全部的内容，包括:代码设计时应遵循哪些原则、代码不规范会导致什么后果除了维护起来难，据说会让系统瘫痪，程序中断电脑死机什么意思、2019软件著作权源代码文件撰写要求等相关内容解答，如果想了解更多相关内容，可以关注我们，你们的支持是我们更新的动力！