首页 > 编程语言 >编程规约-命名风格

编程规约-命名风格

时间:2022-09-07 11:45:34浏览次数:70  
标签:name 示例 规约 编程 反例 接口 规则 命名

编程规约-命名风格

命名规则一、正确的英文拼写和合理的缩写和语法规则

正确示例

// 国际通用的名称 可视同英文
ali
alibaba
taobao
cainiao
aliyun
youku  
hangzhou 

反例一、使用下划线或美元符号开始或者结束

_name
name_
$name
name$
__name
name__

反例二、使用拼音或者中文

DaZhePromotion [打折] 
getPingfenByName() [评分] 
String fw[福娃] 
int 某变量 = 3

反例三、族歧视性词语

RIBENGUIZI[日本人]
Asan[印度人]
blackList[黑名单 blockList]
whiteList[白名单 allowList]
slave[从属 secondary]

反例四、不规范的缩写

AbsClass[AbstractClass]
condi[condition]
Fu[Function]

命名规则二、包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式

命名规则三、类名使用 UpperCamelCase 风格,但以下情形例外:DO/BO/DTO/VO/AO/PO/UID等

正确示例

ForceCode
UserDO
HtmlDTO
XmlService
TcpUdpDeal
TaPromotion

异常类命名使用 Exception 结尾, 测试类命名以它要测试的类的名称开始,以 Test 结尾

命名规则四、抽象类命名使用 Abstract 或 Base 开头;

命名规则五、接口和实现类的命名有两套规则

A、对于 Service 和 DAO 类,基于 SOA 的理念,暴露出来的服务一定是接口,内部的实现类用Impl 的后缀与接口区别

正例:CacheServiceImpl 实现 CacheService 接口

B、如果是形容能力的接口名称,取对应的形容词为接口名(通常是–able 的形容词)

正例:AbstractTranslator 实现 Translatable 接口。

命名规则六、方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格

正确示例

localValue
getHttpMessage()
inputUserId

命名规则七、常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长

正确示例

MAX_STOCK_COUNT / CACHE_EXPIRED_TIME

反例

MAX_COUNT
EXPIRED_TIME

命名规则八、数据类型声明

A、数组:类型与中括号紧挨相连来表示。

正确示例

int[] arrayDemo

B、提升辨识度:表示类型的名词放在词尾

正确示例:

startTime
workQueue
nameList
TERMINATED_THREAD_COUNT

反例:

startedAt
QueueOfWork
listName
COUNT_TERMINATED_THREAD

标签:name,示例,规约,编程,反例,接口,规则,命名
From: https://www.cnblogs.com/gcbeen/p/16664841.html

相关文章

  • 面向对象编程
    面向对象编程什么是面向对象?面向对象编程(OOP)是**一种计算机编程模型,它围绕数据或对象而不是功能和逻辑来组织软件设计**.对象可以定义为具有独特属性和行为的数据字......
  • 计算机编程领域的三十种基本思想概览
    运用之妙,存乎一心。计算机编程领域的基本思想,是大量实践与经验的提炼总结,是近乎于“道”的东西。有了思想的指引,就如同有高人指路,行不迷惑,遇事有法,运用之妙,存乎一心。......
  • 终于实现了一门属于自己的编程语言
    前言都说程序员的三大浪漫是:操作系统、编译原理、图形学;最后的图形学确实是特定的专业领域,我们几乎接触不到,所以对我来说换成网络更合适一些,最后再加上一个数据库。这四......
  • Java 并发编程解析 | 如何正确理解Java领域中的并发锁,我们应该具体掌握到什么程度?
    苍穹之边,浩瀚之挚,眰恦之美;悟心悟性,善始善终,惟善惟道!——朝槿《朝槿兮年说》写在开头对于Java领域中的锁,其实从接触Java至今,我相信每一位JavaDeveloper都会有这样......
  • 河北稳控科技可编程 USB 转串口适配器开发板与振弦传感器测量模块
    河北稳控科技可编程USB转串口适配器开发板与振弦传感器测量模块可编程USB转UART/I2C/SMBusS/SPI/CAN/1-Wire适配器USB2S(USBToSerialports)是多种数字接口物理层协议转......
  • 什么是面向对象编程(OOP)?
    什么是面向对象编程(OOP)?面向对象编程,通常缩写为OOP,是一种流行的编程范式。它被许多软件应用程序/技术公司使用,并得到各种编程语言(例如,C++、Python、Java)的支持。在本文中,......
  • 03 程序化编程:变量和控制流介绍
    03程序化编程:变量和控制流介绍变量和控制流介绍让我们看看下面的程序:{01_variables1.py}如果你去03_procedural_programming目录和类型蟒蛇01_variables1.py,您将......
  • 快速入门脚本编程-按键精灵Q语言
    按键精灵的Q语言不仅支持函数,条件控制,多线程编程更有图片识别,文字识别.既然快速入门,那我就介绍比较重要的些关键字及其用法.掌握这些就能开始编写自动化刷副本的脚本......
  • 从零开始学python必看,“Python编程三剑客”,你值得拥有
    从0开始学Python,就问你一句:慌不慌?   第一本:《Python编程:从入门到实践》   第二本:《Python编程快速上手-让繁琐工作自动化》   第三本:《《Python极客......
  • 53 | JAVA_TCP编程
    TCP编程使用Socket进行网络编程时,本质上就是两个进程之间的网络通信。其中一个进程必须充当服务器端,它会主动监听某个指定的端口,另一个进程必须充当客户端,它必须主动连接......