Is there a best practice for writing a summary and text of parameters for how many details you need to get, use or not use full sentences, or something else? I'm just looking for some good habits to establish when I start using them more. Thank!
public class JustinBieber{ private readonly bool HasTalent; JustinBieber(){ HasTalent = false; } /// <summary> /// JustinBieber object sings a song in specified style /// </summary> /// <param name="songName">The song to be sung</param> /// <param name="style">The style in which the song is sung</param> public void SingSong(string songName, string style){ ... } }
My rule of thumb here is to use enough detail to clearly convey meaning, and no more.
- , , XML- intellisense. , , , , " " <remarks>.
<remarks>
Source: https://habr.com/ru/post/1792849/More articles:Formatting javascript Visual Studio .NET 2010 - javascriptHow to display a PDF file? - androidPrevious and Next buttons are displayed on new lines using jQuery UI datepicker - jqueryUsing AJAX web services directly - javascriptRails invokes an action from a view - ruby | fooobar.comAssigning an instance clone to the base interface - c #Flash: tracking mouse position after clicking and dragging (down and back), even outside the scene / browser? - javascriptCore Graphics: mask image, add Overlay and Underlay - iosKeyword maven -SNAPSHOT not replaced - javaCan I prevent WCF from rolling back a transaction when an error occurs? - .netAll Articles