programing

Python에서 여러 줄의 코멘트를 작성하려면 어떻게 해야 하나요?

goodsources 2023. 1. 13. 19:56
반응형

Python에서 여러 줄의 코멘트를 작성하려면 어떻게 해야 하나요?

여러 줄의 코멘트를 작성하려면 어떻게 해야 하나요?대부분의 언어에는 다음과 같은 블록 주석 기호가 있습니다.

/*

*/

세 개의 따옴표로 묶은 문자열을 사용할 수 있습니다.docstring(클래스/함수/모듈의 첫 번째 항목)이 아닌 경우 무시됩니다.

'''
This is a multiline
comment.
'''

.''' IndentationError

Guido van Rossum(Python의 크리에이터)은 이것을 「프로 팁」이라고 트윗했다.

그러나 Python의 스타일 가이드인 PEP8은 다음과 같은 연속된 한 코멘트를 사용하는 것을 선호합니다.

# This is a multiline
# comment.

...이것은, 많은 프로젝트에서 볼 수 있는 것입니다.일반적으로 텍스트 편집기에는 이 작업을 쉽게 수행할 수 있는 바로 가기가 있습니다.

Python은 문서 문자열로 사용되지 않는 한 여러 문자열/댓글 구문을 가지고 있습니다.#- 코멘트 - 추천 코멘트. - 추천 코멘트.사실상, 그것은 코멘트처럼 행동한다.

한편, 이 동작이 참된 코멘트 구문이 되도록 공식 문서에 문서화되어야 한다고 말하는 경우, 언어 사양의 일부로 보장되지 않는다고 말하는 것이 옳습니다.

코멘트 '을 할 수 .# ' ' ' ' ' ' ' ' ' ' ' 이 '' ' 그렇지 않은 경우 해당 텍스트 편집기로 전환합니다.

특정 텍스트 편집 기능이 없는 Python에서 프로그래밍하는 것은 고통스러운 경험이 될 수 있습니다.적절한 에디터를 찾는 것(그리고 그 사용법을 아는 것)은 Python 프로그래밍 경험에 큰 차이를 가져올 수 있습니다.

텍스트 에디터는 선택한 영역에 주석을 달 수 있을 뿐만 아니라 코드 블록을 좌우로 쉽게 이동할 수 있어야 합니다.또, 를 누르면, 커서가 현재의 들여쓰기 레벨에 자동적으로 배치됩니다.코드 폴딩도 편리합니다.


링크 붕괴를 방지하기 위해 Guido van Rossum의 트윗 내용은 다음과 같습니다.

@BSUCSClub Python 힌트:여러 줄의 코멘트로 여러 줄의 문자열을 사용할 수 있습니다.docstring으로 사용하지 않는 한 코드는 생성되지 않습니다. :- )

인정된 답변에 따르면...

세 개의 따옴표로 묶은 문자열을 사용할 수 있습니다.docstring(클래스/함수/모듈의 첫 번째 항목)이 아닌 경우 무시됩니다.

이것은 전혀 사실이 아니다.코멘트와는 달리, 세 개의 따옴표로 둘러싸인 문자열은 여전히 구문 분석되며 소스 코드의 어디에 나타나든 구문적으로 유효해야 합니다.

이 코드를 실행하려고 하면...

def parse_token(token):
    """
    This function parses a token.
    TODO: write a decent docstring :-)
    """

    if token == '\\and':
        do_something()

    elif token == '\\or':
        do_something_else()

    elif token == '\\xor':
        '''
        Note that we still need to provide support for the deprecated
        token \xor. Hopefully we can drop support in libfoo 2.0.
        '''
        do_a_different_thing()

    else:
        raise ValueError

둘 중 하나를...

ValueError: invalid \x escape

...Python 2.x 또는...

SyntaxError: (unicode error) 'unicodeescape' codec can't decode bytes in position 79-80: truncated \xXX escape

...Python 3.x에서.

파서에 의해 무시되는 여러 줄의 코멘트를 할 수 있는 유일한 방법은...

elif token == '\\xor':
    # Note that we still need to provide support for the deprecated
    # token \xor. Hopefully we can drop support in libfoo 2.0.
    do_a_different_thing()

Python 2.7에서는 여러 줄의 코멘트는 다음과 같습니다.

"""
This is a
multilline comment
"""

수업 중에 있는 경우에는 적절하게 탭을 눌러야 합니다.

예를 들어 다음과 같습니다.

class weather2():
   """
   def getStatus_code(self, url):
       world.url = url
       result = requests.get(url)
       return result.status_code
   """

AFAIK, Python, Python.행의 코멘트에 는, 「」를 사용할 수 .#★★★★★★ 。

Notepad++사용하고 있는 경우는, 블록 코멘트의 쇼트 컷이 있습니다.gVim이나 Emacs 같은 다른 제품들도 비슷한 기능을 가지고 있을 거예요.

아닌 것 같아요.다만 여러 줄의 문자열이 처리되어 있지 않습니다.그러나, 모든 Python IDE에는, 코드의 복수 행의 「코멘트 아웃」을 위한 단축키가 있습니다.

여러 줄의 코멘트와 같은 기능은 없습니다. #코드 한 줄에 코멘트를 다는 유일한 방법입니다.여러분 중 많은 이들이 해결책으로 '''댓글'''이라고 답했습니다.

있는 것 만, 으로는 효과가 있습니다.'''에서는, 이 Python 의 를 사용해 합니다.이 문자열은 인터프리터가 다음과 같은 코멘트를 무시하지 않습니다.#.

여기에서 공식 문서를 확인하십시오.

댓글을 달면

"""
long comment here
"""

스크립트 도중에 Python/linters는 그것을 인식하지 못합니다.위의 코멘트는 표준 권장 사항이 아니기 때문에 접기가 엉망이 됩니다.사용하는 것이 좋다

# Long comment
# here.

Vim 을 사용하는 경우는, commentary.vim같이 플러그 인 해, 를 눌러 코멘트의 긴 행을 자동적으로 코멘트 아웃 할 수 있습니다.Vjgcc서.어디에Vj하고, 「」를 선택합니다.gcc멘트코

위와 같은 플러그인을 사용하지 않으려면 다음과 같이 검색 및 치환할 수 있습니다.

:.,.+1s/^/# /g

그러면 현재 줄과 다음 줄의 첫 번째 문자가 다음과 같이 바뀝니다.#.

Visual Studio Code 범용 공식 다중 줄 설명 전환.Xcode 단축키와 유사합니다.

macOS: code-block을 선택한 /후 +를 선택합니다.

Windows:코드 블록을 선택한 다음 +/를 선택합니다.

안타깝게도 문자열화를 항상 코멘트 아웃으로 사용할 수는 없습니다!따라서 각 행의 선두에 다음 행이 있는 표준을 따르는 것이 안전합니다.#.

다음은 예를 제시하겠습니다.

test1 = [1, 2, 3, 4,]       # test1 contains 4 integers

test2 = [1, 2, '''3, 4,'''] # test2 contains 2 integers **and the string** '3, 4,'

사용하지 말 것을 권합니다."""여러 줄 코멘트!

다음으로 예기치 않은 동작이라고 생각되는 것을 강조하기 위한 간단한 예를 나타냅니다.

print('{}\n{}'.format(
    'I am a string',
    """
    Some people consider me a
    multi-line comment, but
    """
    'clearly I am also a string'
    )
)

이제 출력을 살펴보겠습니다.

I am a string

    Some people consider me a
    multi-line comment, but
    clearly I am also a string

여러 줄의 문자열은 코멘트로 취급되지 않았지만 다음 문자열과 연결되었습니다.'clearly I'm also a string'하나의 스트링을 형성합니다.

복수의 행에 코멘트를 붙이는 경우는, PEP 8 의 가이드 라인에 따라서 코멘트주세요.

print('{}\n{}'.format(
    'I am a string',
    # Some people consider me a
    # multi-line comment, but
    'clearly I am also a string'
    )
)

출력:

I am a string
clearly I am also a string

음, 이것을 시도해 보세요(따옴표를 실행할 때 첫 번째 질문에 대한 입력은 다음과 같이 인용해야 합니다).'):

"""
print("What's your name? ")
myName = input()
print("It's nice to meet you " + myName)
print("Number of characters is ")
print(len(myName))
age = input("What's your age? ")
print("You will be " + str(int(age)+1) + " next year.")

"""
a = input()
print(a)
print(a*5)

그 사이에 무엇이 들어있음"""코멘트가 붙습니다.

한 줄의 코멘트를 찾고 있다면#.

Python의 여러 줄 댓글:

저는 ''도 ''도 효과가 있었어요.

예:

a = 10
b = 20
c = a+b
'''
print ('hello')
'''
print ('Addition is: ', a+b)

예:

a = 10
b = 20
c = a+b
"""
print('hello')
"""
print('Addition is: ', a+b)

Python 2.7.13의 경우:

싱글:

"A sample single line comment "

여러 줄:

"""
A sample
multiline comment
on PyCharm
"""

Python의 인라인 댓글은 해시 문자로 시작합니다.

hello = "Hello!" # This is an inline comment
print(hello)

안녕!

문자열 리터럴 내의 해시 문자는 해시 문자일 뿐입니다.

dial = "Dial #100 to make an emergency call."
print(dial)

긴급통화를 하려면 100번을 누르세요.

해시 문자는, 1 행 또는 복수 행의 코멘트에도 사용할 수 있습니다.

hello = "Hello"
world = "World"
# First print hello
# And print world
print(hello)
print(world)

안녕하세요.

세계

docstring을 지원하려면 텍스트를 이중 따옴표로 묶으십시오.

def say_hello(name):
    """
    This is docstring comment and
    it's support multi line.
    :param name it's your name
    :type name str
    """
    return "Hello " + name + '!'


print(say_hello("John"))

안녕하세요 존!

블록 코멘트에 대해서는 텍스트를 작은 따옴표로 세 개 묶습니다.

'''
I don't care the parameters and
docstrings here.
'''

코드의 행에 코멘트를 쓰는 경우는, 코멘트를 써 주세요.# 기호 앞에 2칸, # 기호 앞에 1칸을 남겨 주세요.

print("Hello World")  # printing

새 줄에 코멘트를 쓸 경우 #기호에 공백 kn을 남겨두고 코멘트를 작성해야 합니다.

# single line comment

코멘트를 1줄 이상 쓰려면 따옴표를 3개 사용합니다.

"""
This is a comment
written in
more than just one line
"""

PyCharm IDE 사용.

Ctrl+/사용하여 코드 행을 지정할 수 있습니다. Ctrl+/를 누르면 현재 행 또는 선택한 여러 행에 대해 한 줄의 코멘트가 표시됩니다.Django 템플릿에서 선택한 소스 코드 블록에 대해서는 이 블록을 태그로 둘러쌉니다.


n = 5
while n > 0:
    n -= 1
    if n == 2:
        break
    print(n)

print("Loop ended.")

모든 라인을 선택한 후 를 누릅니다.


# n = 5
# while n > 0:
#     n -= 1
#     if n == 2:
#         break
#     print(n)

# print("Loop ended.")

네, 둘 다 사용해도 괜찮습니다.

'''
Comments
'''

그리고.

"""
Comments
"""

단, IDE에서 실행할 때 기억해야 할 것은 파일 전체를 여러 줄 코드로 받아들이려면 '실행'해야 한다는 것입니다.한 줄 한 줄 'RUN'이 제대로 작동하지 않고 오류가 표시됩니다.

에서도 가장 은 Python의 하는 IDE 입니다.#.

Anaconda Spyder를 사용하고 있으며 다음과 같은 기능이 있습니다.

  • Ctrl + - 코멘트/코멘트 없음
  • Ctrl + - 코드 블록을 코멘트합니다.
  • Ctrl + - 코드 블록을 주석 해제합니다.

행에는 코드의 코멘트//코멘트/코드가 1행/복수 행/초입니다.#.

그게 제일 쉬워요.

예를 들어, 블록 코멘트는 다음과 같습니다.

# =============================================================================
#     Sample Commented code in spyder
#  Hello, World!
# =============================================================================

이것은 Vim 텍스트에디터로 실행할 수 있습니다.

댓글 영역의 첫 번째 줄 선두로 이동합니다.

Ctrl+V를 눌러 비주얼 모드로 들어갑니다.

화살표 키를 사용하여 주석을 달 모든 행을 선택합니다.

Shift+I를 누릅니다.

#(또는 Shift+3)를 누릅니다.

Esc 키를 누릅니다.

할 때는 단순히 Python을 입니다.#행에 한 줄 : " " " " " " 。

# This is comment 1
# This is comment 2 
# This is comment 3

Python에서 "올바른" 여러 줄의 코멘트를 작성하기 위해 여러 줄의 스트링을 사용하여"""구문 Python에는 문서 문자열(또는 문서 문자열) 기능이 있습니다.프로그래머에게 모든 Python 모듈, 함수, 클래스, 메서드를 빠르게 추가할 수 있는 쉬운 방법을 제공합니다.

'''
This is
multiline
comment
'''

또한 다음과 같은 클래스 오브젝트로 docstring에 액세스할 수 있습니다.

myobj.__doc__

Python에는 여러 줄의 코멘트가 실제로 존재하지 않습니다.다음 예시는 구문 오류에 대해 Python에 의해 검증되는 할당되지 않은 문자열로 구성되어 있습니다.

Notepad++와 같은 일부 텍스트 편집기는 코드나 단어를 코멘트할 수 있는 단축키를 제공합니다.

def foo():
    "This is a doc string."
    # A single line comment
    """
       This
       is a multiline
       comment/String
    """
    """
    print "This is a sample foo function"
    print "This function has no arguments"
    """
    return True

또한 +는 Notepad++에서 댓글을 차단하는 바로 가기입니다.가 추가된다.#선택 항목 아래에 있는 모든 줄 앞에 있습니다.Ctrl + + 는 블록 언코멘트용입니다.

주석을 달 행을 선택한 다음 +를 사용하여 Sublime Text 편집기에서 Python 코드를 주석 또는 주석 해제하십시오.

한 줄의 경우 + 를 사용할 수 있습니다.

다음을 사용할 수 있습니다.이것은 DockString이라고 불립니다.

def my_function(arg1):
    """
    Summary line.
    Extended description of function.
    Parameters:
    arg1 (int): Description of arg1
    Returns:
    int: Description of return value
    """
    return arg1

print my_function.__doc__

네, 간단하게 사용할 수 있습니다.

'''
Multiline!
(?)
'''

또는

"""
Hello
World!
"""

보너스: 조금 어렵지만 이전 버전에서 사용하는 것이 더 안전합니다.print 또는 " " GUI:

# This is also
# a multiline comment.

하고 를 .Ctrl / (오류) /PyCharmVS Code에 있습니다.

하지만 편집할 수 있습니다.를 들어, 수 .Ctrl /로로 합니다.Ctrl Shift C.

경고!

  1. 다른 바로 가기를 덮어쓰지 않도록 주의하십시오!
  2. 코멘트는 올바르게 들여써야 합니다!

이 답변이 도움이 되었기를 바랍니다.다음에 또 다른 답을 쓸 때 행운을 빌어요!

windows:하고 Windows를 누를 도 있습니다.ctr + /: mac에 있어야 합니다.comment + /

언급URL : https://stackoverflow.com/questions/7696924/how-do-i-create-multiline-comments-in-python

반응형