Search

autoDocstring

대분류
DevOps/Tool
소분류
VSCode Extension
설명
Python 코드 설명 작성기
유형
Python
부유형
Auto Docs
프레임워크
Nest
최종 편집 일시
2024/10/27 15:21
생성 일시
2024/10/10 04:25
12 more properties
floatFirstTOC: right
YAML
복사

autoDocstring: VSCode Python Docstring Generator

파이썬 함수에 대한 독스트링을 빠르게 생성하는 Visual Studio Code 확장 프로그램

기능

•
탭으로 이동할 수 있는 문서 문자열 스니펫을 빠르게 생성하세요.
•
여러 가지 유형의 문서 문자열 형식 중에서 선택하세요.
•
pep484 유형 힌트, 기본값, 변수 이름을 통해 매개변수 유형을 유추합니다.
•
args, kwarg, 데코레이터, 오류 및 매개변수 유형 지원

문서 문자열 형식

독스트링에서 유형 생성을 끄려면 원하는 형식의 -notypes 템플릿을 사용하세요. docBlockr 형식은 PEP0257의 유형화된 버전입니다.

사용법

커서가 정의 바로 아래 줄에 있어야 전체 자동 채워진 문서 문자열을 생성할 수 있습니다.
•
큰따옴표(""" 또는 '''로 구성 가능)로 문서 문자열을 연 후 Enter 키를 누릅니다.
•
키보드 단축키: ctrl+shift+2 또는 cmd+shift+2(Mac의 경우)
◦
환경설정 -> 키보드 단축키 -> extension.generateDocstring에서 변경할 수 있습니다.
•
명령에서 변경할 수 있습니다: 독스트링 생성
•
오른쪽 클릭 메뉴: 독스트링 생성

확장 프로그램 설정

이 확장은 다음과 같은 설정을 제공합니다:
•
autoDocstring.doc

사용자 지정 문서 문자열 템플릿

이 확장 프로그램은 이제 사용자 정의 템플릿을 지원합니다. 이 확장 프로그램은 mustache.js 템플릿 엔진을 사용합니다. 사용자 정의 템플릿을 사용하려면 .mustache 파일을 만들고 customTemplatePath 구성을 사용하여 경로를 지정하세요. 사용 예는 포함된 Google 문서 스트링 template을 참조하세요. 사용자 정의 템플릿에서 사용할 수 있는 태그는 다음과 같습니다.

변수

{{name}} - 함수 이름 {{summaryPlaceholder}} - 플레이스 홀더 요약 {{extendedSummaryPlaceholder}} - [확장_요약] 플레이스홀더
Plain Text
복사

Sections

{{#args}} - 함수 인자 반복 {{var}} - 변수 이름 {typePlaceholder}} - _유형_ 또는 추측된 유형 플레이스홀더 {{descriptionPlaceholder}} - _description_ 플레이스홀더 {{/args}} {{#kwargs}} - 함수 kwargs 반복 {{var}} - 변수 이름 {{typePlaceholder}} - _유형_ 또는 추측된 유형 플레이스홀더 {{&default}} - 기본값(& 변수 이스케이프 해제) {{descriptionPlaceholder}} - _description_ 플레이스홀더 {{/kwargs}} {{#exceptions}} - 예외 반복 {{type}}}} - 예외 유형 {{descriptionPlaceholder}} - _description_ 플레이스홀더 {{/exceptions}} {{#yield}} - 수익률 반복 {{typePlaceholder}} - _유형_ 플레이스홀더 {{descriptionPlaceholder}} - _description_ 플레이스홀더 {{/yields}} {{#returns}} - 수익률 반복 {{typePlaceholder}} - _유형_ 플레이스홀더 {{descriptionPlaceholder}} - _description_ 플레이스홀더 {{/returns}}
Plain Text
복사

Additional Sections

{{#argsExist}} - 인자가 존재하면 내용 표시 {{/argsExist}} {{#kwargsExist}} - kwargs가 존재하면 내용을 표시합니다 {{/kwargsExist}} {{#parametersExist}} - args 또는 kwargs가 존재하면 내용을 표시합니다. {{/parametersExist}} {{#exceptionsExist}} - 예외가 존재하면 내용을 표시합니다 {{/exceptionsExist}} {{#yieldsExist}} - 반환이 존재하면 내용을 표시합니다. {{/yieldsExist}} {{#returnsExist}} - 반환이 존재하면 내용 표시 {{/returnsExist}} {{#placeholder}} - 콘텐츠를 플레이스홀더로 만듭니다. {{/placeholder}}
Plain Text
복사