Общие правила по оформлению программного кода:

•имена элементов разработки, свойств и действий задавайте как можно короче. При этом они должны быть осмысленными и говорящими, так как в дальнейшем это упростит читаемость кода и понимание другими разработчиками;

•для идентификаторов переменных, параметров используйте нотацию camelCasing: первое слово пишется с маленькой буквы, остальные слова – с большой. Для всех остальных – PascalCasing, в том числе для задания имен свойствам сущности. Подробнее см. в документации Microsoft статью «Соглашения о написании прописными буквами»;

•сокращения в именах идентификаторов не должны влиять на понятность имени. Не используйте аббревиатуры или неполные слова в идентификаторах, если только они не являются общепринятыми;

•имя сущности задавайте в единственном числе. Так как в среде разработки автоматически генерируется пространство имен репозитория с именем сущности во множественном числе;

•избегайте лишних скобок, обрамляющих выражения целиком;

•содержимое класса или функции должно быть сдвинуто на два пробела относительно объявления:

partial class ContractFunctions

{
  /// <summary>
  /// Показывать сводку по документу в заданиях на согласование и подписание.
  /// </summary>
  /// <returns>True, если в заданиях нужно показывать сводку по документу.</returns>
  [Public]
  public override bool NeedViewDocumentSummary()
  {
    return true;
  }
  ...
}

Для автоматического форматирования кода используйте сочетание клавиш Ctrl+I, предварительно настроив отступы в среде разработки. Для этого в меню последовательно выберите пункты: Инструменты, далее Параметры, закладка Текстовый редактор, Поведение, укажите необходимые настройки:

•переменные рекомендуется объявлять с помощью ключевого слова var вместо явного указания типа:

public static bool IncludedInRole(string roleName)

{
  var ceoRole = Roles.GetAll(r => r.Name == roleName).FirstOrDefault();
  if (ceoRole == null)
  {
    return false;
    var employee = Users.Current;
    return employee.IncludedIn(ceoRole);
  }
}

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

•пишите комментарии к коду в XML-формате. Чтобы быстро написать комментарий по формату, в среде разработки Directum RX введите ///. В результате автоматически вставится структура комментария:

/// <summary>

/// 
/// </summary>
/// <param name=""></param>
/// <returns></returns>

Содержимое комментария зависит от кода. Например, если в коде реализован метод без параметров, то при вводе /// структура комментария будет без строки /// <param name=""></param>. А если в коде метода указан параметр, то его название автоматически укажется в теге <param>, например, /// <param name="responsible"></param>.