반응형 docstring2 VSCode - Python 자동 주석 생성 autoDocstring 코드를 작성하다보면, 코드가 점점 길어지고, 작성한 함수에서 사용하는 파라미터를 일일이 기억해서 사용하는것이 어려워진다. 이때 함수에 작성해 놓은 주석 생성을 도와주는 유용한 앱이 있다. autoDocstring 앱을 설치하고 쌍따옴표 3개를 입력하면 Docstring을 생성할 것인지를 확인하는 창이 나타난다. 여기에서 엔터를 누르면, 현재 기준으로 함수 설명, 입력 값, 출력 값의 기본 포맷을 만들어 주어서 쉽게 설명을 작성할 수 있다. 2024. 3. 25. Pylint - docstring "Missing function or method docstring" 메시지 Pylint는 파이썬 코드의 품질을 향상시키기 위한 도구로, 코드의 구문 오류, 스타일 오류, 잠재적인 버그 등을 검사한다. 이 중 "Missing function or method docstring" 메시지는 함수나 메서드에 docstring이 없음을 나타난다. docstring이란? docstring은 함수나 클래스, 모듈의 목적, 사용 방법, 반환값 등을 설명하는 주석이다. docstring을 작성하면 코드의 이해도를 높이고, 다른 개발자가 코드를 이해하고 수정하기 쉽게 할 수 있다. docstring의 구조 docstring은 세 부분으로 구성된다. 개요(summary) 함수나 메서드의 목적을 한 문장으로 요약 문서화(documentation 함수나 메서드의 사용 방법, 반환값, 입력값 등을 설명.. 2024. 3. 2. 이전 1 다음 반응형
