Kommentare
1.1 Kommentare
Lassen Sie ein Leerzeichen nach dem „#“-Zeichen und trennen Sie Absätze durch Leerzeilen (das „#“-Zeichen ist ebenfalls erforderlich) # 块注释
# 块注释
#
# 块注释
# 块注释
1.2. Zeilenkommentare
sollten durch mindestens zwei Leerzeichen von Aussagen getrennt werden # 正确的写法
x = x + 1 # 边框加粗一个像素
# 不推荐的写法(无意义的注释)
x = x + 1 # x加1
Vorschläge
In wichtigen Teilen des Codes (oder komplexeren Stellen) Wer Kommentare schreiben kann, sollte versuchen, Kommentare für wichtigere Kommentarabschnitte zu schreiben. Verwenden Sie mehrere Gleichheitszeichen, um sie zu trennen, um sie auffälliger zu machen. Heben Sie die Wichtigkeit hervor
app = create_app(name, options)
# =====================================
# 请勿在此处添加 get post等app路由行为 !!!
# =====================================
if __name__ == '__main__':
app.run()
2. Dokumentationskommentare (Docstring)
Docstring als Dokument erscheint im Allgemeinen im Kopf des Moduls, der Funktion und der Klasse, also in Python-Dokumenten kann über das __doc__-Objekt des Objekts abgerufen werden. Editoren und IDEs können auch automatische Eingabeaufforderungen basierend auf Docstring geben. Dokumentkommentare beginnen mit „““ Am Anfang und Ende darf die erste Zeile nicht umgebrochen werden. Wenn mehrere Zeilen vorhanden sind, muss die letzte Zeile umgebrochen werden. Das Folgende ist ein Beispiel für den Docstring-Stil von Google.
# -*- coding: utf-8 -*-
"""Example docstrings.
This module demonstrates documentation as specified by the `Google Python
Style Guide`_. Docstrings may extend over multiple lines. Sections are created
with a section header and a colon followed by a block of indented text.
Example:
Examples can be given using either the ``Example`` or ``Examples``
sections. Sections support any reStructuredText formatting, including
literal blocks::
$ python example_google.py
Section breaks are created by resuming unindented text. Section breaks
are also implicitly created anytime a new section starts.
"""
Kopieren Sie den Funktionsdefinitionsprototyp nicht Dokumentationskommentar, aber beschreiben Sie den spezifischen Inhalt im Detail.
# 不推荐的写法(不要写函数原型等废话)
def function(a, b):
"""function(a, b) -> list"""
... ...
# 正确的写法
def function(a, b):
"""计算并返回a到b范围内数据的平均值"""
... ...
Die Beschreibung von Funktionsparametern, Rückgabewerten usw. übernimmt den Numpy-Standard. Wie unten gezeigt
def func(arg1, arg2):
"""在这里写函数的一句话总结(如: 计算平均值).
这里是具体描述.
参数
----------
arg1 : int
arg1的具体描述
arg2 : int
arg2的具体描述
返回值
-------
int
返回值的具体描述
参看
--------
otherfunc : 其它关联函数等...
示例
--------
示例使用doctest格式, 在`>>>`后的代码可以被文档测试工具作为测试用例自动运行
>>> a=[1,2,3]
>>> print [x + 3 for x in a]
[4, 5, 6]
"""
Dokumentkommentare sind nicht auf Chinesisch und Englisch beschränkt, sondern mischen Chinesisch und Englisch nicht
Dokumentkommentare sind nicht so lang wie möglich, normalerweise können ein oder zwei Sätze das erklären Situation klar
Module, öffentliche Klassen, öffentliche Methoden, diejenigen, die Dokumentationskommentare schreiben können, sollten versuchen, Dokumentationskommentare zu schreiben
nächsten Abschnitt