c# - How to break up regular comments into paragraphs while keeping StyleCop happy? -


Sometimes a long comment is required; This can happen when a disturbance hack that requires long explanation is. Yes, it is better to fix / fix hacks, but often time is pressurized and it has to be pushed forward in the future. If this is the case, then making a detailed comment is very helpful, which would be replacing the hack with better code. The key would be to ensure that they understand what the hack is doing and why.

Often, many paragraphs are required if the comments like // comment were allowed, the comment would be more readable. However, StyleCop does not like those people, and we agree with it, so we try to stick with all of our suggestions. Now, I can think of three options: 

  //// This is a hack ... //// ................ ..//////// to hack this hack When deciding on ... //// ........................... ........

(I do not like for the first time because I usually use double / triple / quadruple comments for comments of sections of code I'm sorry).

// This is a hack ... // .................. //// & lt; == It will slide, but I think it looks dumb // After deciding this hack, make sure that ... // .................... ...............

(I do not like the second option; I think this looks dumb) 

  // & lt; Paragraph & gt; // This is a hack ... // .................. // & lt; / Paragraph & gt; // & lt; Paragraph & gt; // After deciding this hack, make sure that ... // .................................. // & lt; / Paragraph & gt;

(I do not like the third option too. It is suitable for the /// method documentation, but here it is an out-of-the- P>

Please suggest a better way.

/ *
make me any time For a long comment has been received, regardless of the reason, I use the "slashterix" block comment style.

Always works for me.
YMMV, but this is my The best suggestion is 8)
* /

< / Html>
-

Comments

Post a Comment

Popular posts from this blog

Eclipse CDT variable colors in editor -

I hope this is a good question to ask here. This programming is related, so I thought it would be better than the superuser, so I am using the CDT C ++ Eclipse plugin. I know how the editor changes colors for some things But is there a way to do that all the variables are different colors? For example in KDEValue, it sets the local variables and square variables in different colors and bold square squares. Can I copy it to CDT? Eclips provides some level of color customization for text editor syntax You can see it on the following: There are many elements, including the Window> Preferences> C / C ++> Editor> Syntax color code that can be changed, assembly, Comments, Preprocessor and Doxian Under the code, it is possible to change the color of some variable types, such as global variables, local variable announcements, local variable references, and parameter variables. But I do not think the code is capable of changing the color of each variable declared....
Read more

AJAX doesn't send POST query -

$ (दस्तावेज़) .ready (function () {function ajaxselectrss (rssurlvar) {var ajaxRequest; // वेरिएबल जो अजाक्स को संभव बनाता है! कोशिश करें कि {// ओपेरा 8.0+, फ़ायरफ़ॉक्स, सफारी अजाक्स अनुरोध} = नया एक्सएमएलएचटीपीआरइवेस्ट ();} कैच (ई) {// इंटरनेट एक्सप्लोरर ब्राउज़र्स {ajaxRequest = new ActiveXObject ("Msxml2.XMLHTTP");} पकड़ो (ई) {try {ajaxRequest = new ActiveXObject ("Microsoft.XMLHTTP");} कैच (ई) {// कुछ गलत चेतावनी ("आपका ब्राउज़र तोड़ दिया!"); वापसी झूठी;}}} // एक बनाएं फ़ंक्शन जो सर्वर से भेजे गए डेटा प्राप्त करेंगे ajaxRequest.onreadystatechange = function () {if (ajaxRequest.readyState == 4) {var ajaxDisplay = document.getElementById ('news'); ajaxDisplay.innerHTML = ajaxRequest.responseText;}} / / Var rssurlvar = $ (this) .attr ("title"); var queryString = "rurl =" + rssurlvar; var urltofile = "rssget.php"; ajaxRequest.open ("पोस्ट", urltofile, सच); ajaxRequ Est.setRequestHeader ("सामग्री-प्र...
Read more

wpf - Custom Message Box Advice -

Well, I'm using a custom window box that comes with some custom control boxes that accompany the text The producers who are displayed are called. I have a defined event, which has been subscribed through the original class, it gets burnt when clicking on the button. However, I can not see how to use it effectively, I would like to return one yes, whether yes or not, but obviously my code will continue to execute, so this Below is some example code to clarify the problem that the method has subscibed by clicking on the button. Message box window Public partial class custom message box: window {public representative message messagebox object sender, event events e); Public event messagebox handler messagebox document; Public Customs Box () {Initial group (); } Public Customsbox (String Message) {InitializeComponent (); This.txtdescription.Text = Message; } Public Customsbox (String Message, String Title, String First BTNtext) {Initialization (); This.lbltitle.Content =...
Read more