The first is called a single line comment and, as implied, only applies to a single line in the "source code" (the program). The amount of time required to go back and figure out how something works is much larger after you’ve already built the function. Comment what you consider needed - but don’t tell others your life story. Suggested Best Practices Write your function with one purpose. Outdated comments can be more of a detriment than no comment at all, so remember to maintain and update comments regularly along with everything else. /* */ is much safer to use because it doesn’t cause errors when the line break is removed. Inline comments are unnecessary and in fact distracting if they state the … They should start with a # and a single space. This would be the best time to leave open and honest comments about your code. If a function is called with a missing argument, the value of the missing argument is set to undefined. When the function has one expression, a good practice is to inline the arrow function. At a minimum, provide a helpful synopsis, description, parameter (for all), and example This is a general programming best practice — making sure that you create functions that fulfill one job at a time makes it easy for other developers to debug and change your code without having to scan through all the code to work out what code block performs what function. It is a good coding practice to put all declarations at the top of each script or function. Inline comments should be separated by at least two spaces from the statement. Single-line comments are referred to as inline comments when they appear at the end of a line of code. Write your function with one purpose. Avoid using the line comment //. Best practices in comment writing and documentation . Before the function keyword. Note that comments are just as much a part of the code as the program itself. An inline comment is a comment on the same line as a statement. If you debug using comments, there is a nice little trick: 3 /** documentation */ This is a documentation comment and in general its called doc comment. There are usually two syntactic ways to comment. Ask Question Asked 8 years, 11 months ago. 2 //text. Comment-based help for a function can appear in one of three locations: At the beginning of the function body. ... for example it can't check if you have used misleading english to describe the purpose of a function! Inline Comments. For example: It is a good habit to assign default values to arguments. Additionally this will give you practice to getting used to commenting all of your files. The compiler ignores everything from // to the end of the line. Syntax for comment-based help in functions. The comparison operators >, <, <= and >= look similar to the fat arrow => (which defines the arrow function). When these comparison operators are used in an inline arrow function, it creates some confusion. Undefined values can break your code. Commenting is best done before actually writing the code for your program. At the end of the function body. ... Use the built in comment-based help system. Fat arrow and comparison operators. There cannot be more than one blank line between the last line of the function help and the function keyword. DESCRIPTION Particularly when the comment must be frequently edited, as with the help and documentation for a function or script. Use the built in comment-based help system. The JDK javadoc tool uses doc comments when preparing automatically generated documentation. Comments are specially marked lines of text in the program that are not evaluated. Inline comments Comments on the same line as a statement can be distracting, but when they don't state the obvious, and particularly when you have several short lines of code which need explaining, they can be useful. Here is another example where I call a function from a third party library: In these particular examples, the type of commenting (or documentation) used is … 3. Comment & Description; 1 /* text */ The compiler ignores everything from /* to */. Don’t build in everything but the kitchen sink. The comments I added at the function definition can be previewed whenever I use that function, even from other files.