upgrade comments of class constructors

ghost commented 3 years ago

it is necessary to improve the comments of class constructors.

uselessgoddess commented 3 years ago

@Konard Now they are better? https://github.com/linksplatform/Ranges/blob/f133625e55e874bdf433fb16cedb538cae43e564/csharp/Platform.Ranges/Range%5BT%5D.cs#L33-L37 https://github.com/linksplatform/Ranges/blob/f133625e55e874bdf433fb16cedb538cae43e564/csharp/Platform.Ranges/Range%5BT%5D.cs#L45-L51

Konard commented 3 years ago

@FreePhoenix888 @TwinkmrMask do you have any ideas how to make these comments better?

FreePhoenix888 commented 3 years ago

 /// <summary> 
 /// <para>Initializes a <see cref="Range"/> instance.</para> 
 /// <para>Инициализирует экземпляр <see cref="Range"/>.</para> 
 /// </summary> 
 /// </summary> 
 /// <param name="minimum"><para>The minimum value of the range.</para><para>Минимальное значение диапазона.</para></param> 
 /// <param name="maximum"><para>The maximum value of the range.</para><para>Максимальное значение диапазона.</para></param> 
 /// <exception cref="ArgumentException"><para>The <paramref name="maximum"/> is less than the <paramref name="minumum"/>.</para><para><paramref name="maximum"/> меньше <paramref name="minumum"/>.</para></exception>

Take an example from here. Check how they have written Exceptions. Shorter: remove Thrown when ... from your exception description, write only the condition when the exception throwns. By the way I would recommend to read about recommended tags for docs.

Konard commented 3 years ago

 /// <summary> 
 /// <para>Initializes a <see cref="Range"/> instance.</para> 
 /// <para>Инициализирует экземпляр <see cref="Range"/>.</para> 
 /// </summary> 
 /// </summary> 
 /// <param name="minimum"><para>The minimum value of the range.</para><para>Минимальное значение диапазона.</para></param> 
 /// <param name="maximum"><para>The maximum value of the range.</para><para>Максимальное значение диапазона.</para></param> 
 /// <exception cref="ArgumentException"><para>The <paramref name="maximum"/> is less than the <paramref name="minumum"/>.</para><para><paramref name="maximum"/> меньше <paramref name="minumum"/>.</para></exception>

Take an example from here. Check how they have written Exceptions. Shorter: remove Thrown when ... from your exception description, write only the condition when the exception throwns. By the way I would recommend to read about recommended tags for docs.

Nice one, can you please apply your changes to all constructors? Make a commit with a message Closes #47 and it will close this issue.

FreePhoenix888 commented 3 years ago

Should I push it into main branch directly or create a branch and pull request?

Konard commented 3 years ago

@FreePhoenix888 directly.

TwinkmrMask commented 3 years ago

Gentlemens, the <summary> tag is closed 2 times There was also an agreement to write at the beginning of <param> Представляет/Represents something For example:

Represents the minimum value of the range.

FreePhoenix888 commented 3 years ago

Gentlemens, the <summary> tag is closed 2 times There was also an agreement to write at the beginning of <param> Представляет/Represents something For example:

Represents the minimum value of the range.

Do you have any thoughts how to improve documentation here?

linksplatform / Ranges

upgrade comments of class constructors #47