代码编写的原则总结

本文总结了软件设计的基本原则,强调了编码质量、代码可读性与可维护性的重要性。提出了代码编写规范,包括删除无用代码、添加注释、遵循30秒原则、函数长度限制、变量定义位置、一行一事、括号使用、代码格式化和接口声明。同时,详细介绍了命名规范,如使用有意义的英文单词、类名与方法名的大小写规则、全局变量与常量全大写等。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

想知道软件编程中的基本原则(请看:软件设计的原则总结),当然对于代码的编写原则,我也查找了一些资料,下面就是一些代码编写的原则,如果有补充的,请留言。下面从三个方面来说:

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

2、代码编写规范

      2.1 删除所有无用代码

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

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

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

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

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

      2.7 使用括号来控制操作符的运算顺序。

      2.8 对代码进行格式化,再进行提交。

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

3、命名规范

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

      3.2 类名:首字母大写,每个单词首字母都需要大写

      3.3 方法名:首字母小写,其余单词首字母都需大写。

      3.4 全局变量,和常量名称要求全部字母大写

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

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

科技眼

共同努力!共同进步!

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值