Komen

Komen )

# 块注释
# 块注释
#
# 块注释
# 块注释

1.2. Komen baris

hendaklah dipisahkan daripada penyataan sekurang-kurangnya dua ruang Berhati-hati untuk tidak menggunakan komen yang tidak bermakna

# 正确的写法
x = x + 1  # 边框加粗一个像素
# 不推荐的写法(无意义的注释)
x = x + 1 # x加1

1.3 Dicadangkan supaya

bahagian kod (atau tempat yang lebih kompleks) Cuba tulis komen

bahagian komen yang lebih penting, dipisahkan dengan berbilang tanda yang sama, boleh menjadi lebih menarik perhatian dan menyerlahkan kepentingan

app = create_app(name, options)
# =====================================
# 请勿在此处添加 get post等app路由行为 !!!
# =====================================
if __name__ == '__main__':
    app.run()

2. Dokumenkan ulasan (Dokumen)

Docstring sebagai dokumen biasanya muncul dalam pengepala modul Pengepala jabatan, fungsi dan kelas, supaya dokumen itu boleh diperolehi melalui objek __doc__ objek dalam ular sawa Editor dan IDE juga boleh memberikan gesaan automatik berdasarkan Docstring .

Komen dokumen bermula dan berakhir dengan """, Baris pertama tidak putus. Jika terdapat berbilang baris, baris terakhir mesti putus. Berikut ialah contoh gaya docstring 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.
"""

Jangan salin fungsi prototaip definisi dalam ulasan dokumentasi, tetapi huraikan kandungan khususnya, terangkan parameter khusus dan nilai pulangan, dsb. tidak terhad kepada bahasa Cina dan Inggeris, tetapi jangan campurkan bahasa Cina dan Inggeris

Komen dokumentasi tidak selama yang boleh, biasanya satu atau dua ayat boleh menerangkan keadaan Hanya jelaskan

Modul, kelas awam, kaedah awam yang boleh menulis ulasan dokumentasi harus mencuba yang terbaik untuk menulis ulasan dokumentasi