Следует ли использовать аббревиатуру компании или инструментария в качестве префикса к C# именам классов и методам - PullRequest
Новая
       42

Следует ли использовать аббревиатуру компании или инструментария в качестве префикса к C# именам классов и методам

0 голосов
/ 15 апреля 2020

Я ищу информацию, касающуюся именования класса C# с идентифицирующим префиксом или суффиксом, который относится к набору инструментов или компании, к которой относится библиотека.

Например, предположим, что название компании - Audio Решения и они хотят создать библиотеку классов C# для инструментария с именем Audio Control Toolkit.

Пример использования сокращенного названия компании AS: 

namespace AudioSolutions.AudioControlToolkit

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

Пример использования сокращения инструментария 

namespace AudioSolutions.AudioControlToolkit

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

Использование вышеуказанных префиксов желательно для определения того, какие части приложения используют инструментарий. Есть ли опубликованная информация об использовании вышеуказанного подхода к кодированию бренда от поставщика? Я не знаю, приведут ли вышеуказанные соображения к именам проблемы или считаются плохой практикой. Заранее спасибо.

Обновление 15.04.2020 12:15 PST

Эта topi c, похоже, очень ориентирована на предпочтения, и никто еще не нашел широко опубликованных материалов по этому вопросу. , Я нашел одно место с большим именем, используя идентификатор в префиксе их классов или методов, приведенных ниже. Вот несколько примеров:

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 определенного поставщика, я мог найти только одну другую причину добавления такого префикса. Эта причина состояла бы в том, чтобы компилятор не жаловался на неоднозначность между 2 или более вызовами функций с одним и тем же именем, но разными пространствами имен. В этом случае ее легко решить, решив, какая реализация поставщика полностью квалифицирует имена своих функций с пространством имен в качестве префикса в исходном коде.

Ответы [ 2 ]

1 голос
/ 15 апреля 2020

Я бы рекомендовал не вводить названия компаний / аббревиатуры в название класса, а вместо этого использовать пространство имен. Я не помню, чтобы когда-либо видел название компании, включенное непосредственно в имена классов на любом из используемых мной фреймворков / инструментариев.

Например, у Telerik есть несколько очень популярных фреймворков / инструментариев, и те, обычно содержат Telerik в пространстве имен (например, Telerik.Reporting, Telerik.ReportViewer. Mvc), но никогда в самих именах классов.

0 голосов
/ 15 апреля 2020

Обновление 15.04.2020 12:15 PST

Эта топика c, похоже, очень ориентирована на предпочтения, и никто еще не нашел какого-либо широко опубликованного материала по этому вопросу. Я нашел одно место с большим именем, используя идентификатор в префиксе их классов или методов, приведенных ниже. Вот несколько примеров:

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 определенного поставщика, я мог бы найти только одну другую причину добавления такого префикса. Эта причина состояла бы в том, чтобы компилятор не жаловался на неоднозначность между 2 или более вызовами функций с одним и тем же именем, но разными пространствами имен. В этом случае ее легко решить, решив, какая реализация поставщика полностью квалифицирует имена своих функций с пространством имен в качестве префикса в исходном коде.

...