【问题标题】:What is a proper name for a method that execute SQL query?执行 SQL 查询的方法的正确名称是什么?
【发布时间】:2015-09-03 14:43:45
【问题描述】:

我通常会创建一个类,将所有执行查询的方法放入某种数据库。 是否存在为该方法提供正确名称的任何约定?也许我做错了什么,但我总是有超长的名字,比如“SelectIdAddressPriorityFromMyTableWhereIp”。 这种方法有什么好听的名字?

【问题讨论】:

  • 我不熟悉任何约定,但我建议根据它的 用途 而不是它 的作用 来命名它。只要是描述性的,名称的长度根本不会打扰我。
  • 我更关心的是,所有东西都在一个“Iwilldoeverything”类中。也许你应该考虑一种不同的模式。
  • 您可能最好创建某种通用方法,该方法将接受查询、参数集合并返回数据集或受影响的行数等,而不是针对每个语句的特定方法你可能想要。
  • @sab669 是的,类似于 insertIntoPostgres(string query, List values, string options)。
  • @Steve 我在一个类中拥有所有 Postgres 插入/选择/更新。这是一个不好的做法吗?不是一切,只有数据库交互

标签: c# sql methods naming conventions


【解决方案1】:

该标准没有为方法名称提供任何特定的命名约定。但是建议使用名称以便熟悉并且容易让读者(您或其他人)理解它的作用。函数的长度无关紧要,只要提供方法的目的,便于他人维护和理解即可。

【讨论】:

  • 好的,我发布的示例“SelectIdAddressPriorityFromMyTableWhereIp”是一个好名称,用于执行从 MyTable 中选择 id、地址、优先级的方法,其中 ip =“192.168.1.1”?
  • @AndreaCattaneo:- 正如我所说,只要您觉得它可以理解,那就很好。这将是高度基于意见和有争议的,以及说这是好是坏。 (当事情没有按标准规定时,一切都是关于意见和舒适)
  • "LoadIPAdressData" 或类似的东西我认为应该足够了,可以从方法内部的连接数据中查找它加载的数据库,并且可以很容易理解 where 子句,因为该方法将最可能需要它作为参数。这只是一个意见,而不是任何一成不变的东西。提供足够的信息但不要提供太多信息是我命名方法的方式。
  • 我要补充一点,如果你的方法被设计为异步运行,它应该在方法名称上有一个Async 后缀。
猜你喜欢
  • 2021-04-11
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2020-06-28
相关资源
最近更新 更多