The // MARK: and // MARK: – syntax in Swift functions identically to the #pragma mark and #pragma mark – syntax in Objective-C. When using this syntax (plus // TODO: and // FIXME:), you can get some extra information to show up in the quick jump bar. Consider these few lines of source code: // … Read more
Easy: // Single line comment /* Multi line comment */
The first form is called Javadoc. You use this when you’re writing formal APIs for your code, which are generated by the javadoc tool. For an example, the Java 7 API page uses Javadoc and was generated by that tool. Some common elements you’d see in Javadoc include: @param: this is used to indicate what … Read more
<%– Commented out HTML/CODE/Markup. Anything with this block will not be parsed/handled by ASP.NET. <asp:Calendar runat=”server”></asp:Calendar> <%# Eval(“SomeProperty”) %> –%> Source
Current The TypeScript team, and other TypeScript involved teams, created a TSDoc specification. https://tsdoc.org/ Example straight from the docs: export class Statistics { /** * Returns the average of two numbers. * * @remarks * This method is part of the {@link core-library#Statistics | Statistics subsystem}. * * @param x – The first input number … Read more
The Jenkinsfile is written in groovy which uses the Java (and C) form of comments: /* this is a multi-line comment */ // this is a single line comment
The CSV “standard” (such as it is) does not dictate how comments should be handled, no, it’s up to the application to establish a convention and stick with it.
Well, since this is about comments and code, let’s look at some actual code. Compare this typical code: float a, b, c; a=9.81; b=5; c= .5*a*(b^2); To this self-documenting code, which shows what is being done: const float gravitationalForce = 9.81; float timeInSeconds = 5; float displacement = (1 / 2) * gravitationalForce * (timeInSeconds … Read more
Use the <%# %> sequence, e.g. <%# This is a great comment! %>
I doubt you’ll get a better answer than, “Guido didn’t feel the need for multi-line comments”. Guido has tweeted about this: Python tip: You can use multi-line strings as multi-line comments. Unless used as docstrings, they generate no code! 🙂