1. 코드 주석 소개
처리 로직이 있는 코드에서는 소스 프로그램에서 유효한 주석의 양이 20% 이상이어야 합니다.
관련 학습 권장사항: python 비디오 튜토리얼
2. 코드 주석 분류
줄 주석: 기호 뒤의 줄은 컴파일(표시)되지 않습니다.
댓글 차단: 블록 주석 기호 중간 부분은 컴파일되지 않습니다
3. 파이썬 코드 주석의 기본
#은 Python에서 한 줄 주석을 나타내는 데 사용됩니다. 한 줄 주석은 주석 처리되는 코드 줄 위나 문이나 표현식 뒤에 별도의 줄로 배치할 수 있습니다. 다음 예:
name = 'xiaohong' # 한 줄 주석
# 한 줄 주석
name = 'xiaohong'
Python에서는 작은 따옴표 세 개나 큰 따옴표 세 개를 사용하여 여러 줄을 나타냅니다. 댓글. 다음 예와 같이 작성할 댓글이 너무 많을 때 사용됩니다.
'''
이것은 세 개의 작은 따옴표를 사용한 여러 줄 주석입니다.
'''"""
이것은 여러 줄의 주석입니다. 세 개의 큰따옴표를 사용하는 줄 주석
"""
IV. DocStrings 소개 및 사용
4.1 DocStrings 소개
Document strings
은 문서 프로그램을 해석하는 데 중요한 도구입니다. 그리고 프로그램을 돕습니다. 문서가 더 간단하고 이해하기 쉽습니다
4.2 Python에서 DocStrings 사용
함수 본문의 첫 번째 줄에 작은따옴표 세 쌍 ''' 또는 큰따옴표 세 쌍 """을 사용하세요. 문서 문자열을 정의합니다. doc(이중 밑줄 참고)를 사용하여 함수에서 docstring 속성을 호출할 수 있습니다.
작성 예는 다음과 같습니다.
def add(num1,num2): """ 完成传入的两个数之和 :param num1: 加数1 :param num2: 加数2 :return: 和 """ return num1 + num2 print( add.__doc__ )
참고: DocStrings 문서 문자열 사용 규칙: 첫 번째 줄은 함수를 간략하게 설명합니다.
5. DocStrings의 일반적인 쓰기 스타일
5.1 reST 스타일
style now, sphinx의 표준 형식인 reST 스타일은 비교적 컴팩트합니다.
5.2 Google 스타일""" This is a reST style. :param param1: this is a first param :param param2: this is a second param :returns: this is a description of what is returned :raises keyError: raises an exception """5.3 Numpydoc(Numpy 스타일)
""" This is a groups style docs. Parameters: param1 - this is the first param param2 - this is a second param Returns: This is a description of what is returned Raises: KeyError - raises an exception """
6. 일부 댓글 경험
위 내용은 Python 코드 주석 사양 코드 구문 분석의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!