公司或工具包的缩写应用作C#类名和方法的前缀

问题描述 投票:0回答:2

我正在寻找有关带有标识前缀或后缀的C#类命名的信息,该前缀或后缀指的是库所来自的工具箱或公司。

例如,假设公司名称为Audio Solutions,他们想为名为Audio Control Toolkit的工具包创建C#类库。

使用AS的公司缩写的示例:

namespace AudioSolutions.AudioControlToolkit

public class AS_FileConversions
{
  public static AS_MP3toWave() { .... }
}

使用工具箱缩写的示例

namespace AudioSolutions.AudioControlToolkit

public class ACT_FileConversions
{
  public static ACT_MP3toWave() { .... }
}

希望使用上述前缀来标识应用程序的哪些部分正在使用工具箱。是否有有关使用上述方法从供应商处获得品牌代码的任何公开信息?我不知道上述命名注意事项是否会引起问题或被视为不良做法。预先感谢。

PST更新4/15/2020 12:15 pm

此主题似乎是非常偏爱的,没有人找到有关此问题的广泛出版的材料。我确实在它们的类或方法的前缀中使用标识符找到了一个大名鼎鼎的地方,以下是一些示例:

https://cuda-tutorial.readthedocs.io/en/latest/tutorials/tutorial01/来自上述站点页面的示例编码对象:

cudaMalloc((void**)&d_a, sizeof(float) * N);
cudaMemcpy(d_a, a, sizeof(float) * N, cudaMemcpyHostToDevice);
cudaFree(d_a);

除了确定是否正在使用某个供应商的sdk函数外,我只能找到添加此前缀的其他原因。这样做的原因是为了避免编译器抱怨两个或更多个具有相同名称但名称空间不同的函数调用之间的歧义。在这种情况下,可以通过确定哪个供应商的实现以源代码中的名称空间作为前缀完全限定其功能名称来轻松解决。

c# naming-conventions class-library
2个回答
1
投票

我建议不要将公司名称/缩写放在类名称中,而应使用名称空间。我想我没有回想起曾经在我使用过的任何框架/工具包的类名称中直接包含公司名称。

例如,Telerik有许多非常流行的框架/工具包,这些框架/工具包通常在名称空间中包含Telerik(例如Telerik.Reporting,Telerik.ReportViewer.Mvc),但从来没有在类名本身中包含。


0
投票

PST更新4/15/2020 12:15 pm

此主题似乎是非常偏爱的,没有人找到有关此问题的广泛出版的材料。我确实在它们的类或方法的前缀中使用标识符找到了一个大名鼎鼎的地方,以下是一些示例:

https://cuda-tutorial.readthedocs.io/en/latest/tutorials/tutorial01/来自上述站点页面的示例编码对象:

cudaMalloc((void**)&d_a, sizeof(float) * N);
cudaMemcpy(d_a, a, sizeof(float) * N, cudaMemcpyHostToDevice);
cudaFree(d_a);

除了确定是否正在使用某个供应商的sdk函数外,我只能找到添加此前缀的其他原因。这样做的原因是为了避免编译器抱怨两个或更多个具有相同名称但名称空间不同的函数调用之间的歧义。在这种情况下,可以通过确定哪个供应商的实现以源代码中的名称空间作为前缀完全限定其功能名称来轻松解决。

© www.soinside.com 2019 - 2024. All rights reserved.