Comments
1, comments
1.1, block comments
"#" 기호 뒤에 공백이 있으며, 문단은 빈 줄로 구분됩니다. ("#" 기호도 필수입니다. )
# 块注释
# 块注释
#
# 块注释
# 块注释
1.2. 라인 주석
은 공백 두 개 이상으로 구분되어야 합니다. 의미 없는 주석을 사용하지 않도록 주의하세요.
주석은 키에 작성하는 것이 좋습니다. 코드의 일부(또는 더 복잡한 부분) 주석을 작성해 보세요
더 중요한 주석 섹션을 여러 개의 등호로 구분하면 더 눈길을 끌고 중요성을 강조할 수 있습니다
# 正确的写法
x = x + 1 # 边框加粗一个像素
# 不推荐的写法(无意义的注释)
x = x + 1 # x加1
2. 문서 주석(Docstring)
문서로서의 Docstring은 일반적으로 모듈 헤더에 나타납니다. 부서, 함수 및 클래스의 헤더는 Python에서 개체의 __doc__ 개체를 통해 문서를 얻을 수 있도록 편집기 및 IDE에서도 Docstring을 기반으로 자동 프롬프트를 제공할 수 있습니다.
문서 주석은 """로 시작하고 끝나므로 첫 번째 줄은 끊어지지 않습니다. 여러 줄이 있는 경우 마지막 줄은 끊어야 합니다. 다음은 Google의 독스트링 스타일의 예입니다
app = create_app(name, options)
# =====================================
# 请勿在此处添加 get post等app路由行为 !!!
# =====================================
if __name__ == '__main__':
app.run()
함수 정의 프로토타입을 복사하지 마세요. 문서 주석에는 구체적인 내용을 자세히 설명하고, 특정 매개 변수와 반환 값 등을 설명합니다.
# -*- 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.
"""
함수 매개 변수, 반환 값 등에 대한 설명은 아래와 같이 numpy 표준을 채택합니다.
# 不推荐的写法(不要写函数原型等废话)
def function(a, b):
"""function(a, b) -> list"""
... ...
# 正确的写法
def function(a, b):
"""计算并返回a到b范围内数据的平均值"""
... ...
문서 주석 중국어와 영어에 국한되지 않고 중국어와 영어를 섞지 마세요
문서 주석은 최대한 길지 않으며 일반적으로 한두 문장으로 상황을 설명할 수 있습니다. 그냥 명확하게 설명하세요
모듈, 공개 클래스, 공개 방법 저것들. 문서 댓글을 작성할 수 있는 사람은 최선을 다해 문서 댓글을 작성해야 합니다
다음 섹션
