Документирование кода

Материал из ODANT Wiki
Перейти к: навигация, поиск

Документирование кода - это вставка в код определенных комментариев, которые позволяют в дальнейшем упростить работу с кодом, как автору, так и другим программистам. Для документирования кода в ODA используется стандартный подход документирования кода C# в Visual Studio. Для того, чтобы вставить комментарий перед функцией или классом необходимо набрать на клавиатуре '///'. После этого будет вставлен стандартный комментарий. Для функции данный комментарий описывает кроме общей информации еще и описание параметров и результат. Комментарий операторов необходимо делать на строке, предшествующей оператору, а не в начале и конце строки. Это позволит в будущем удобно исправлять и дописывать код. В случае выполнения правил документирования классов и функций можно будет делать документацию на код автоматически средствами Visual Studio.

Ниже пример правильно документированного кода для ODA

[csharp,N]

   /// <summary>
   /// Описание класса
   /// </summary>
   public class Init: MainInit
   {
       /// <summary>
       /// Описание функции
       /// </summary>
       /// <param name="Параметр">Описание параметра</param>
       /// <returns>Описание результата</returns>
       public int НазваниеФункции(int Параметр)
       {
           //Описание действия
           return Параметр + 1;
       }
   }