我正在编写一个应用程序,其中一个变量可能会受到应用于从DB读取的数据的不同筛选器的影响。每个不同的变体都必须存储在不同的变量中(因为每个变量都有不同的用途),但是,我不确定这种情况的最佳命名约定,因为它在某个时候会成为一个公共访问的API。一个简单的例子:
meterPrice
:原名。meterPriceBySuburb
:带有郊区过滤器的新变量。meterPriceBySuburbByType
:带郊区和类型过滤器的新变量。meterPriceBySuburbByTypeBySchool
:你明白重点了。对于这些变量应该遵循的命名,我有两个主要关切:
MeterPriceDistributionChartDataBySuburbByTypeBySimilarity
。经度本身是否是面向公共API的问题?meterPriceBySuburbTypeSimilarity
:一个接一个,接着一个,By
。meterPriceBySuburbByTypeBySimilarity
:在每个过滤器之前都有By
。meterPriceBySuburbAndTypeAndSimilarity
:拥有第一个By
,然后使用And
跟踪每个新的D30
。meterPriceBySuburbTypeAndSimilarity
:有一个初始的By
,只需将And
添加到最终的过滤器中。谢谢您的回复!为我糟糕的英语感到抱歉。
发布于 2020-05-31 03:43:16
这是我的第一个孩子。他叫DancesWithWolves。
我为什么不叫他FirstChild?因为名字不一定是你如何得到数据的故事。这可能是你将如何使用变量的故事。这可能是关于变量对你意味着什么的故事。
但是您正在编写API,所以您不知道如何使用这些数据。但是至少你知道为什么你认为这个查询应该存在。当你想出一个名字的时候,考虑一下这个问题。不要太专注于查询的结构。如果这就是所有的名字所传达的,那比让人们创建他们自己的查询要好得多。用这个名字告诉我为什么我在乎郊区过滤器。至少,这将更令人难忘,并且有机会在编写查询的上下文之外成为有意义的和难忘的。
https://softwareengineering.stackexchange.com/questions/410854
复制