首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

接口命名约定

接口命名约定是指在软件开发中,为了提高代码的可读性和可维护性,对接口(函数、方法、类、模块等)进行命名时所遵循的一些规范和约定。以下是一些常见的接口命名约定:

  1. 使用有意义的名称:接口名称应该能够清晰地表达接口的功能和作用,避免使用模糊的名称。
  2. 遵循命名规范:接口名称应该遵循所使用编程语言的命名规范,例如驼峰命名法或下划线命名法。
  3. 避免特殊字符:接口名称应该只包含字母、数字和下划线等字符,避免使用特殊字符。
  4. 遵循一致的命名风格:接口名称应该遵循一致的命名风格,例如大驼峰命名法或小驼峰命名法。
  5. 避免过长的名称:接口名称应该尽量简短,但不能过于简略,以免影响代码的可读性。
  6. 使用动词或动词短语:接口名称应该尽量使用动词或动词短语,以表达接口的操作或功能。
  7. 使用常量表示固定值:接口名称应该使用常量表示固定值,例如数字或字符串常量。

在实际开发中,开发人员应该根据具体的项目和团队规范来制定接口命名约定,以提高代码的可读性和可维护性。

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

Java 命名约定

原文 - Java Naming Conventions - By Lokesh Gupta Java 命名约定体提一种指导规范,在应用开发的过程中,程序开发者遵守这些指导规范来产出一致且易读的代码...Java 中广泛使用驼峰规则来命名方法,变量等,并使用首字母大写命名类和接口。 下面,我们用案例来说明这些命名规则。 1....接口命名 在 Java 中,接口命名一般使用形容词。接口名是首字母大写的驼峰式方式。在一些场景中,当接口表示一个类集合,比如List 和 Map,也可以使用名词。...常量命名约定 Java 常量应该是全大写的字符,多个字符之间使用 _ 字符来连接。 请确保在常量中使用 final 修饰符。...泛型命名约定 泛型参数名应该是单个大写的字符。推荐使用 T 字母。在 JDK 类中,字母 E 通常用于作为集合类中,字母 S 通常用于服务加载类中,字母 K 和 V 通常用于映射类中的键和值的类型。

28030

Vue组件的Prop命名约定

在编程中,有两个极具挑战性的任务:缓存失效和命名事物。今天,我们将深入探讨后者,探索为Vue组件命名props的艺术。 在给 props 命名时,遵循已有的变量命名惯例是非常重要的。...例如,使用小驼峰命名法(isEnabled)并保持名称简短(不超过30个字符)。 然而,Vue有自己的一套最佳实践,我们应该遵循。让我们根据我在使用Vue的经验谈谈一些技巧。...描述性命名 Props 应该描述组件本身,侧重于它的功能而不是为什么要这样做。避免以当前用户或环境命名 props。... 避免将 props 命名为子组件。...按照这些准则,我们可以为Vue应用程序建立一致且有意义的 prop 命名约定。周到的 prop 名称有助于提高代码的可读性和可维护性,使你和团队更容易有效地合作。

29130
  • Google C++ 编程风格指南(六):命名约定

    命名规则具有一定随意性, 但相比按个人喜好命名, 一致性更重, 所以不管你怎么想, 规则总归是规则. 6.1. 通用命名规则 函数命名,变量命名,文件命名要有描述性;少用缩写。...文件命名 文件名要全部小写, 可以包含下划线 (_) 或连字符 (-). 按项目约定来. 如果并没有项目约定,”_” 更好。...所有类型命名 —— 类, 结构体, 类型定义 (typedef), 枚举 —— 均使用相同约定....或 class, 参照 pos 的形式 sparse_hash_map: STL 相似实体; 参照 STL 命名约定 LONGLONG_MAX: 常量, 如同 INT_MAX 译者(acgtyrant...)笔记 感觉 Google 的命名约定很高明,比如写了简单的类 QueryResult, 接着又可以直接定义一个变量 query_result, 区分度很好;再次,类内变量以下划线结尾,那么就可以直接传入同名的形参

    1.6K20

    某神秘公司 RESTful、共用接口、前后端分离、接口约定的实践

    等等………… 重构 下面步入正题,面对以上众多问题聊聊我是如何重新制定流程的 数据库约定 约定数据库里所有表必须包含名为id主键字段。 可能有人会说,正常来说不是每张表里都应该有id主键吗?...api出参约定 约定所有出参里含list,且其他请求会用到这组list,则list里所有对象必须含id唯一标识。 入参约定 约定token身份认证统一传入参数模式,后端采用aop切面编程识别用户身份。...resultfull接口约定 首先我们选择一个名词复数,比如产品 post方法 新增一条XXX 比如 ……/products 则代表新增一条产品 入参json如下: { "name":"我是一款新产品...权限约定 服务端要对用户角色进行判断,是否有权限执行某个逻辑。 前后端分离约定 后端以开发接口为主,不再参与页面开发,或者混合式jsp页面开发,统一以接口形式返回,前端通过js渲染数据以及处理逻辑。...关于restful风格api,每个人都有自己的见解,只要内部约定清楚,能尽可能少的减少沟通,我觉得就是好的理解。

    82930

    调用约定

    调用约定   本文内容概括自IDA pro权威指南第66页到第69页6.2.1节调用约定   调用约定指定函数调用方放置调用函数时所需参数的具体位置(如栈中、寄存器中),此外,还约定了再函数调用结束后由谁负责从栈中删除这些参数...在使用IDA的F5功能时经常能够看到函数签名中带有cdecl、fastcall等字样,这些就是调用约定。调用约定是通常是特定于语言、编译器和CPU的,这里只简单了解一下主流的调用约定。...C调用约定(cdecl)   x86体系结构的许多C编译器使用的默认调用约定叫做C调用约定(cdecl)。...标准调用约定(stdcall)   标准调用约定的“标准”是由微软为自己的调用约定所起的名称stdcall得来。...微软对所有共享库(DLL)文件输出的参数数量固定的函数使用stdcall约定。 x86 fastcall调用约定 fastcall调用约定时stdcall约定的一个变体。

    86040

    某小公司 RESTful、共用接口、前后端分离、接口约定的实践

    等等………… 重构 下面步入正题,面对以上众多问题聊聊我是如何重新制定流程的 数据库约定 约定数据库里所有表必须包含名为id主键字段。 可能有人会说,正常来说不是每张表里都应该有id主键吗?...api出参约定 约定所有出参里含list,且其他请求会用到这组list,则list里所有对象必须含id唯一标识。 入参约定 约定token身份认证统一传入参数模式,后端采用aop切面编程识别用户身份。...resultfull接口约定 首先我们选择一个名词复数,比如产品 post方法 新增一条XXX 比如 ……/products 则代表新增一条产品 入参json如下: { "name":"我是一款新产品...权限约定 服务端要对用户角色进行判断,是否有权限执行某个逻辑。 前后端分离约定 后端以开发接口为主,不再参与页面开发,或者混合式jsp页面开发,统一以接口形式返回,前端通过js渲染数据以及处理逻辑。...关于restful风格api,每个人都有自己的见解,只要内部约定清楚,能尽可能少的减少沟通,我觉得就是好的理解。

    69940

    在线商城项目04-接口约定和数据请求

    简介 本篇我们主要进行如下工作: 接口约定 数据请求 1. 接口约定 本项目我们不做复杂的接口约定。目前仅约定如下返回规则。...目前我们仅约定一个异常 { "code": "102", "msg": "未登录" } 实际当然没有这么简单,我们可能会约定几个错误集,比如‘000’代表正常,‘1’开头的表示账户相关错误信息,...这些后续我们根据项目需求再进行约定。实际项目中大家根据与后端协商来约定。 2. 数据请求 数据请求我们使用axios,这里我们先不做二次封装,直接使用axios,等到后期需要的时候我们再进行封装。...总结 本篇内容很简单,因为只是项目开始,并没有做复杂的接口定义,以及请求封装。

    32830

    EF 约定介绍

    当前环境为EF Code First开发模式中 一、EF默认约定 1、常用约定 (1)、当没有显示指定实体主键的时候,EF会默认将长得最像Id的属性(且类型为GUID)设为主键 (2)、设计实体时,当一个实体包含一个集合属性...除了导航属性规定实体间的关系外,外键属性来式规定实体间方式的一种手段.Code First能够推断以下的命名属性为外键(优先级从上到下): (1)、导航属性名+关联实体的主键名 (2)、关联实体实体名+...(Connection String Conventions) EF 数据库连接约定(Connection String Conventions in Code First) 二、移除约定 EF提供了移除默认约定的方法...,通过该方法我们可以移除所有定义在System.Data.Entity.ModelConfiguration.Conventions namespace下的约定,例如,移出表名复数约定,代码如下: public...modelBuilder.Conventions.Remove(); } } 三、自定义约定 EF 自定义约定

    1.6K100

    约定大于配置

    程序员项目组开发好应用程序的框架之后,遗留下来的项目参数传递接口是以配置文件的方式。配置文件可以在线编辑,动态化配置调整参数信息。...约定大于配置是美国计算机毕业生论文中提出来的。一个应用上线之后会生成很多的基础开发文档和用户手册。配置接口尽量留取较小。用户既是上帝。用户体验和用户的使用反馈很重要。很多的数据参数都是有默认的数据值。...开放出来的配置调参接口很少,可以减少用户出错的概率。高内聚,低耦合。程序内聚的方式通过硬编码的方式体现,硬编码是软件编程的基础源代码,IDE编译完成之后是字节码.class文件。...配置文件是整个应用程序对用户开放出来的接口。大型机器组装成功之后,可视化调整参数界面和很多的机械按钮和计算机编程的配置文件参数调整方式类似。设计模式享元模式对项目种的重复代码不断地抽取。...使用封装内聚,继承复用空间,多态的用户的自定义编码接口。灵活性能在用户需要有保证和体现。

    15020

    Entity Framework 约定

    约定,类似于接口,是一个规范和规则,使用Code First 定义约定来配置模型和规则。在这里约定只是记本规则,我们可以通过Data Annotaion或者Fluent API来进一步配置模型。...约定的形式有如下几种: 类型发现约定 主键约定 关系约定 复杂类型约定 自定义约定 零、类型发现约定 在Code First 中。...导航属性的命名规则如下:导航属性名称+主体主键名称 或者 主体类名+主键属性名称 或者 主体主键属性名。...自定义约定包含一个约定接口 IConvention,IConceptualModelConvention 是概念模型接口,在模型创建后被调用,IStoreModelConvention 接口为存储模型接口...modelBuilder.Conventions.AddBefore(new DateTime2Convention()); } 在开发过程中都会存在开发规范,例如对表名命名的规则

    1.3K10

    函数调用约定

    芯片只是规定了指令集,只要是指令集中的指令都是可以执行的正确指令,而函数是语义级别的功能块,如何让函数的大厦在指令集之上建立起来就是函数调用约定。...函数调用约定主要解决这几个问题: l 参数以什么顺序入栈或者以什么顺序进入寄存器完成传递 l 调用其它函数的时候要保存本函数的寄存器现场,谁来保存,保存哪些寄存器 l 函数退出时候要恢复调用者的寄存器现场...恢复哪些寄存器 l 如何给函数命名。这里的命名是指如何编码参数和返回值类型到函数名中。一般编译之后的代码的函数名都不是代码中编程语言规定的函数名。而是根据这个生成的。...这对这几个问题的不同答案,有几种比较著名的约定:stdcall ,cdecl ,fastcall ,thiscall ,naked call 入栈顺序 函数命名方式 栈清理方 默认使用者

    2.3K20

    下划线在命名中的约定(Underscores in Python)

    下划线在命名中的约定(Underscores in Python) 作者: quantgalaxy@outlook.com blog: https://blog.csdn.net/quant_galaxy...介绍 在各种python编码规范中,都对命名规则做了很详细的约定。 但是下划线和变量名称的组合,在python中都有特定的含义。...这些含义有些是一种认为约定,有些是python解释器严格执行的准则。 有必要掌握这些约定,来写出专业的代码。 2....and a Double Trailing Underscore): __variable__ 单下划线(Only Single Underscore): _ 后面我们就针对这5种和下划线组合相关的变量约定...除了变量以外,函数命名也是一样的规则。 所以这里它是由Python解释器强制执行的。 总结: 单前下划线在类成员命名中,约定是在类内部可见。实际访问是不受限制的。

    22940

    使用C# 11的静态接口方法改进 面向约定 的设计

    C# 11带来了一个我期待已久的特性——接口方法。我们知道接口是针对契约的定义,但是一直以来它只能定义一组“实例”的契约,而不能定义类型(的静态成员)的契约,因为定义在接口中的方法只能是实例方法。...由于缺乏针对“类型契约”的支持,我们在设计一些框架或者类库的时候,只能采用“按照约定”的设计,比如ASP.NET Core Minimal API针对参数的绑定就是一个典型的案例。...这样的实现也比较繁琐,我们不得不通过反射检验待绑定参数的类型是否满足约定,并以反射(或者表达式树)的方式调用对应的方法。其实上述两个方法本应该写入“契约”,无赖它们是静态方法,没法定义在接口中。...如果有了这样的接口,确定带绑定参数类型是否满足之前的约定条件只需要确定其是否实现了对应的接口就可以了。...provider, [MaybeNullWhen(false)] out TSelf result); } 静态接口设计被应用到《用最少的代码打造一个Mini版的gRPC框架》中,我在表示gRPC服务的接口中定义了如下的静态方法

    67020

    API的性能约定

    虽然如今的 API 规范并没有以一种正确性证明的方式来明确正确性的标准,但是 API 函数/接口的类型声明和文档描述了其逻辑行为的确定性。 然而,API 函数/接口的意义不仅只有功能的正确性。...人们常常根据自己对某个函数的实现做出假设,对于任何复杂的API函数或者接口,不同的人可能会给出不同的性能预期,而API 文档很少提示执行成本高昂或者低廉。...API的性能约定 为什么 API 必须遵守性能约定呢?因为应用程序的主要结构可能取决于 API 是否遵守了这样的性能约定。程序员根据性能期望选择 API、数据结构和整个程序结构。...实际上, 明确性能约定的程序较难与不遵守性能约定的APi相配合。当然,有许多程序的结构和性能很少受到库性能的影响。...每次应用程序绑定到动态库或在操作系统接口上时,都需要验证组合的正确性和API的性能约定。 诚然,API的性能约定没有功能正确性约定那么重要,但是软件系统的核心体验往往取决于它。

    48620

    扫码

    添加站长 进交流群

    领取专属 10元无门槛券

    手把手带您无忧上云

    扫码加入开发者社群

    相关资讯

    热门标签

    活动推荐

      运营活动

      活动名称
      广告关闭
      领券