通常,编码格式声明是必需的。如果 python 源码文件没有声明编码格式,python 解释器会默认使用 ASCII 编码,一旦源码文件包含非ASCII编码的字符,python 解释器就会报错。以 UTF-8 为例,以下两种编码格式声明都是合乎规则的。
缩进
统一使用 4 个空格进行缩进。绝对不要用tab, 也不要tab和空格混用。对于行连接的情况,我一般使用4空格的悬挂式缩进。例如:
引号
自然语言使用双引号
机器标识使用单引号
正则表达式使用双引号
空行
编码格式声明、模块导入、常量和全局变量声明、顶级定义和执行代码之间空两行
顶级定义之间空两行,方法定义之间空一行
在函数或方法内部,可以在必要的地方空一行以增强节奏感,但应避免连续空行
导入模块
导入总应该放在文件顶部,位于模块注释和文档字符串之后,模块全局变量和常量之前。导入应该按照从最通用到最不通用的顺序分组,分组之间空一行
标准库导入
第三方库导入
应用程序指定导入
命名规范
类名使用驼峰(CamelCase)命名风格,首字母大写,私有类可用一个下划线开头
函数名一律小写,如有多个单词,用下划线隔开
私有函数可用一个下划线开头
变量名尽量小写, 如有多个单词,用下划线隔开
常量采用全大写,如有多个单词,使用下划线隔开
代码书写规则通常对应用程序的功能没有影响,但它们对于改善源代码的理解是有帮助的。养成良好的习惯对于软件的开发和维护都是很有益的。
一篇编写规范的代码,不仅让自己维护起来更加方便,也会让其他读者觉得赏心悦目~快来看看如下10点
第一点:源代码文件以文件内容中的最顶层的Java类命名,而且大小写敏感,文件扩展名为.java,同时,文件的编码格式统一为UTF-8。
?
第二点:类的命名遵循大驼峰命名法UpperCamelCase,而方法名和变量名的命名遵循小驼峰命名法lowerCamelCase。常量名使用大写字母表示,单词之间以下划线分隔.jsp的文件名全部小写。
第三点:一个程序文件最好不要超过2000行。
第四点:不用的代码和引用删除.
第五点:请合理运用空行。空行可以用来隔开相对独立的代码块,有利于阅读和理解。但是不要使用超过一行的空行,对空间,别太奢侈了。
第六点:为不容易理解类变量注释。注释代码段,注释逻辑选择。
第七点:对成员方法,不要轻易采用public的成员变量。主要的修饰符有public,private,protected。避免过多的参数列表,尽量控制在5个以内。
?
第八点:原则上关系密切的行应对齐,对齐包括类型、修饰、名称、参数等各部分对齐。另每一行的长度不应超过屏幕太多,必要时适当换行,换行时尽可能在","处或运算符处,换行后最好以运算符打头。
第九点:为避免编程时遇到麻烦,请保证在自己类路径指到的任何地方,每个名字都仅对应一个类。否则,编译器可能先找到同名的另一个类,并报告出错消息。
?
第十点:字符串不应该重复,如果多次用到同一字符串,建议将该字符串定义为字符串常量,再引用。
Java编码规范: 尽量使用完整的英文描述符采用适用于相关领域的术语采用大小写混合使名字可读尽量少用缩写,但如果用了,必须符合整个工程中的统一定义避免使用长的名字(小于15个字母为正常选择)避免使用类似的名字,或者仅仅是大小写不同的名字避免使用下划线(除静态常量等)标识符类型说明包(Package)的命名Package的名字应该采用完整的英文描述符,都是由一个小写单词组成。并且包名的前缀总是一个顶级域名,通常是com、edu、gov、mil、net、org等;如:com.yjhmily.test类(Class)的命名类名应该是个一名词,采用大小写混合的方式,每个单词的首字母大写。尽量保证类名简洁而富于描述。
欢迎分享,转载请注明来源:内存溢出
评论列表(0条)