Stack Comment Resolution For Free

Comments in Python It's better to have no comment at all than one that's difficult to understand or inaccurate. Comments should be updated regularly to reflect changes in your code. Too many comments can be distracting and reduce code quality. Comments aren't needed where the code's purpose is obvious.

Comment Conventions. Python has two types of comments: single line comments (which start with a # sign) and docstrings (which are enclosed in triple quotes). The following is a general rule regarding commenting: Specifications are docstrings; all other comments are single line comments.

You should submit a comment if you want to: Request clarification from the author; Leave constructive criticism that guides the author in improving the post; Add relevant but minor or transient information to a post (e.g. a link to a related question, or an alert to the author that the question has been updated).

A comment in Python starts with the hash character, # , and extends to the end of the physical line. A hash character within a string value is not seen as a comment, though. To be precise, a comment can be written in three ways - entirely on its own line, next to a statement of code, and as a multi-line comment block.

Instead, multiline comments are created by enclosing the text within triple quotes (either single quotes ''' or double quotes "). This is a multiline comment. It can span multiple lines. These lines are not executed as code.

A good best practice to follow when writing comments in code is to describe the why, not the what. In general, good code should be self-explanatory in how it works, at least in isolation. Explain the reasoning behind the code, not just what the code is doing. This can help others understand the intent of the code.

There are usually two syntactic ways to comment. The first is called a single line comment and, as implied, only applies to a single line in the "source code" (the program). The second is called a Block comment and refers usually refers to a paragraph of text.