-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
upgrade comments of class constructors #47
Comments
@Konard Now they are better? Ranges/csharp/Platform.Ranges/Range[T].cs Lines 33 to 37 in f133625
Ranges/csharp/Platform.Ranges/Range[T].cs Lines 45 to 51 in f133625
|
@FreePhoenix888 @TwinkmrMask do you have any ideas how to make these comments better? |
/// <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 |
Nice one, can you please apply your changes to all constructors? Make a commit with a message |
Should I push it into main branch directly or create a branch and pull request? |
@FreePhoenix888 directly. |
Gentlemens, the
|
Do you have any thoughts how to improve documentation here? |
it is necessary to improve the comments of class constructors.
The text was updated successfully, but these errors were encountered: