我是靠谱客的博主 爱听歌冬天,最近开发中收集的这篇文章主要介绍代码编写的原则总结,觉得挺不错的,现在分享给大家,希望可以做个参考。

概述

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

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结束。

最后

以上就是爱听歌冬天为你收集整理的代码编写的原则总结的全部内容,希望文章能够帮你解决代码编写的原则总结所遇到的程序开发问题。

如果觉得靠谱客网站的内容还不错,欢迎将靠谱客网站推荐给程序员好友。

本图文内容来源于网友提供,作为学习参考使用,或来自网络收集整理,版权属于原作者所有。
点赞(43)

评论列表共有 0 条评论

立即
投稿
返回
顶部