VSCode 환경 설정 - python 유용한 설정 AutoDocString

AutoDocString는 VSCode 에서 Python Extension Pack 을 설치할때 포함되어 있는 확장 모듈이다.

팀단위, 여러명의 협업의 효율을 위해 코드내 간단한 Document 를 작성하는데, 막상 개발하다 보면 귀찮을 때가 많다.

대충하거나, 생략할때도 .... 

 

 

AutoDocString은 """ <- 쌍따움표 3개를 입력하면 자동으로 주석 문장을 만들어준다.

def autoDocString(number, argA=1, argB='BB'):
    if(number < 2):
        raise TypeError
    return True

 

함수 정의 안에 """ 입력

def autoDocString(number, argA=1, argB='BB'):
    """_summary_

    Args:
        number (_type_): _description_
        argA (int, optional): _description_. Defaults to 1.
        argB (str, optional): _description_. Defaults to 'BB'.

    Raises:
        TypeError: _description_

    Returns:
        _type_: _description_
    """
    if(number < 2):
        raise TypeError
    return True

 

전달된 변수에 대한 타입, 설명을 붙여주면 끝.

• Press enter after opening docstring with triple quotes (configurable """ or ''')
• Keyboard shortcut: ctrl+shift+2 or cmd+shift+2 for mac