gaspersic/freeCodeCamp
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Adding multiline comments using triple apostrophes (#21296)

Browse Source
This commit is contained in:
SirDickinson
2018-11-09 06:59:13 -06:00
committed by Kristofer Koishigawa
parent 17233b2a66
commit d9e6bc6acc
1 changed files with 15 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
guide/english/python/commenting-code/index.md
View File

@ -15,9 +15,21 @@ Python does not include a formal way to write multiline comments. Each line of a
# This is the first line of a multiline comment. # This is the first line of a multiline comment.
# This is the second line. # This is the second line.
``` ```
Another type of comment is the **docstring**, documented in <a href='https://www.python.org/dev/peps/pep-0257/' target='_blank' rel='nofollow'>`PEP 257`</a>. Docstrings are a specific type of comment that becomes the `__doc__` attribute. Alternatively you could use `'''` to write a a comment that spans multiple lines to avoid having to use the `#`.
For example:
```python
'''
This is a multiline comment,
everything inside the three
apostrophes will be regarded
by Python as a comment and
ignored when running a program
'''
```
For a string literal to be a docstring, it must start and end with `\"\"\"` and be the first statement of the module, function, class, or method definition it is documenting: Another type of comment is the **docstring**, documented in [`PEP 257`](https://www.python.org/dev/peps/pep-0257/). Docstrings are a specific type of comment that becomes the `__doc__` attribute.
For a string literal to be a docstring, it must start and end with `"""` and be the first statement of the module, function, class, or method definition it is documenting:
```python ```python
class SomeClass(): class SomeClass():
@ -32,4 +44,4 @@ For a string literal to be a docstring, it must start and end with `\"\"\"` and
pass pass
``` ```
String literals that start and end with `"""` that are not docstrings (not the first statement), can be used for multiline strings. They will not become `__doc__` attributes. If they are not assigned to a variable, they will not generate bytecode. There is some discussion about using them as multiline comments found <a href='http://stackoverflow.com/questions/7696924/multiline-comments-in-python' target='_blank' rel='nofollow'>here</a>. String literals that start and end with `"""` that are not docstrings (not the first statement), can be used for multiline strings. They will not become `__doc__` attributes. If they are not assigned to a variable, they will not generate bytecode. There is some discussion about using them as multiline comments found [Multiline Comments in Python - Stack Overflow](http://stackoverflow.com/questions/7696924/multiline-comments-in-python).