Dec 14, 2019 · The correct way to do it is to provide a docstring. That way, help(add) will also spit out your comment. """Create a new user. Line 2 of comment... And so on... """ That's three double quotes to open the comment and another three double quotes to end it. You can also use any valid Python string.

Dec 5, 2009 · In general, comments should be dealt with in a similar manner to code separation -- interface-related comments (such as your example) would go in the header, whereas implementation-related comments would be better suited for the .cpp file.

Function Comments: Every function (in both the .h and the .c files) should have a comment describing: what function does; what its parameter values are what values it returns (if a function returns one type of value usually, and another value to indicate an error, your comment should describe both of these types of return values).

Almost every function declaration should have comments immediately preceding it that describe what the function does and how to use it. These comments may be omitted only if the function is simple and obvious (e.g., simple accessors for obvious properties of the class).

Jul 5, 2001 · For code maintained exclusively or primarily by a team that can reach agreement on this issue, it is okay to increase the line length limit up to 99 characters, provided that comments and docstrings are still wrapped at 72 characters.

Dec 23, 2021 · Here are some rules to help you achieve a happy medium: Rule 1: Comments should not duplicate the code. Rule 2: Good comments do not excuse unclear code. Rule 3: If you can't write a clear comment, there may be a problem with the code. Rule 4: Comments should dispel confusion, not cause it. Rule 5: Explain unidiomatic code in comments.

Types of things to mention in comments at the function declaration: What the inputs and outputs are. For class member functions: whether the object remembers reference arguments beyond the duration of the method call, and whether it will free them or not.

Apr 2, 2025 · The first comment explains the purpose of the function, while the in-line comment notes the approximation of π. Avoid redundant comments that simply repeat what the code obviously does. ... Returns: float: The vector's length """ return (self.x**2 + self.y**2)**0.5 The BankAccount docstring describes the class's purpose and lists its ...

Every function declaration should have comments immediately preceding it that describe what the function does and how to use it. These comments should be descriptive ("Opens the file ... ") rather than imperative ("Open the file"); the comment describes the function, it does not tell the function what to do.

Nov 23, 2022 · Mastering Python function comments is essential for writing clean and maintainable code. By following best practices and guidelines, such as providing clear descriptions of parameters, return values, and potential exceptions, you can enhance the readability and understandability of your code.