В чем разница между /// и #region в c #?

#c#

#c#

Вопрос:

В чем разница между операторами ///<Summary> и #region ...#endregion в c #? Какой из них лучший?

Ответ №1:

#region это вообще не оператор comment. Это для разметки разделов кода. /// предназначено для комментариев к документации.

Ответ №2:

 /// <summary>
/// Three forward slashes denote a documentation comment, which can be used in
/// conjunction with documentation tooling to generate API documentation for
/// your code.
/// </summary>

// two forward slashes denote a code comment, which you can use to provide
// commentary within your code

/*
This style of comment is called a block comment, which can be used to easily
comment out large blocks of text within your code
*/

#region Some Region Name

// the above region allows the developer to collapse/uncollapse everything
// within it, as long as their IDE supports regions
public void SomeMethod()
{
}

#endregion
  

Комментарии:

1. 1 … и четыре косых черты //// является стандартным для комментирования строк реального кода, где / * * / не будет работать (и останавливает ReSharper, жалующийся на это 🙂

Ответ №3:

#region делает ваш код читаемым / поддерживаемым / более организованным
/// документирует код!

Ответ №4:

/// предназначен для комментариев XML, в то время как region в предназначен не для комментариев, а для группировки разделов кода вместе.

Ответ №5:

/// -> может использоваться для некоторых комментариев

#region ...#endregion -> может использоваться для обозначения определенного набора кода в регионе, легко переопределяется

 #region MainMethod

        /// <summary>
        /// Comments
        /// </summary>
        static void Main()
        {
            //Your code
        } 
        #endregion
  

Ответ №6:

Совершенно разные вещи, одна предназначена для комментирования / документации, другая — для скрытия кода.

XML-комментарии (///)

#Region

Ответ №7:

/// используется для вставки XML-комментариев в ваш код. Комментарии Xml позволяют создавать выходной XML-файл из вашего проекта: этот файл позже используется Visual Studio для отображения всплывающей подсказки intellisense со вставленными вами комментариями. Более того, вы можете использовать eit для создания собственной документации. Смотрите здесь статью о том, как создавать документацию из Xml-комментариев вашего исходного кода

#region используется для организации вашего кода. Это полезно только в среде IDE, которая это понимает (VS), позволяя вам сворачивать или разворачивать каждую область кода, которую вы определяете с помощью #region /#endregion

Ответ №8:

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

 #region your large code
loads of code in this area.
#endregion

//This is just a note that the computer won't read.