Соглашения об именах для папки C# проекта

Question

У меня есть проект под названием Data, который является слоем данных. В этом проекте все файлы просто лежат в верхней папке. У меня есть перечисления, POCOs, репозитории, частичные классы и так далее.

Если я хочу переместить эти файлы во вложенные папки, каково будет предпочтительное имя папки для каждой папки? Есть ли какое-нибудь соглашение?

Папка «Хранилища» довольно очевидна, но где я должен хранить POCOs и перечисления?

Благодаря

Answer 1

Я предпочитаю использовать папки проекта как способ выделения вспомогательных пространств имен. Так что в вашем случае, возможно, папка Repositories, которая имеет класс в пространстве имен Data.Repositories. Обратите внимание, что для частичных классов каждый файл должен находиться в одном и том же пространстве имен.

Answer 2

Лучшая прецизия состоит в том, чтобы делить объекты в папках по объектной модели, а не по типу.

Answer 3

Хорошей практикой является имя папки после названия проекта.

Design Guidelines for Developing Class Libraries имеет набор Guidelines for Names

Последний пункт должен быть paticular интерес для Вас:

• Names of Assemblies and DLLs
• Names of Namespaces
• Types and Namespaces

Answer 4

Если это не так Чисто как сгруппировать классы по значению использования или объектной модели, просто оставьте их в одной папке. Использование подпапок не дает значений, если они не организуют классы значимым образом.

Разделение папок по типу, например. перечисления, POCOs, репозитории, частичные классы и т. д., вряд ли будут полезны.

Возможно, вы захотите использовать подпапку для сгенерированного кода, который нельзя редактировать.

Также помните, что вы можете иметь папки в проводнике решений, которые не являются частью файловой системы. Учитывая, насколько дорого (вовремя) в некоторых системах управления исходным кодом перемещать файлы между каталогами, я бы подумал о том, чтобы начать использовать только папки msdev, пока вы не очистите нужную структуру.

Там нет необходимости ставить каждое перечисление в своем собственном файле, если перечисление только используется одним классом, действительно положить его в том же файл класса. Например, перечисление PersonSex можно поместить в файл person.cs. Точно так же, если у вас есть много небольшие и тесно связанные классы, рассмотрите возможность их размещения в том же файле.

Answer 5

I (в настоящее время - изменения, основанные на проекте), как правило, использовать этот подход при именовании сборок/проектов/пространств имен в проекте стиля/Web SAAS)

• CompanyName.
  • ProductName.
    • Данные.
    • Бизнес. (справочные данные)
    • Модель. (POCO и интерфейсы - все ссылки)
    • Услуги. (Уровень обслуживания WCF)
    • ServiceClient. (на которые ссылаются веб-клиенты)
    • Веб. (бизнес-уровень веб-клиента)
      • ViewModel. (Вид конкретной модели)
      • {клиент сталкивается с продуктовым сегментом} [Торговля, CMS, CRM, отчетность и т.д.]

Объяснить Услуги/Сервис клиента .. . Я использую IoC (в настоящее время StructureMap), который позволяет моему WebClient либо говорить непосредственно на уровне Business, либо перенаправляться, чтобы говорить через ServiceClient через Services to Business. Это дает мне гибкость при развертывании моего уровня приложения в моих веб-приложениях или распределении частей моего уровня бизнеса (уровня приложения) на разные серверы с помощью принципов WCF/SOA.