본문 바로가기
Python

Python - Missing function or method docstring pylint(missing-function-docstring)

by 올엠 2022. 5. 10.
반응형

 

Pylint는 파이썬을 작성할 때 파이썬 구분 오류를 잡아주는 유용한 도구이다.

오늘은 자주 보는 메세지로 오류라기보다는 주의 검토 메세지인 아래 메세지에 대해서 알아보도록 하겠다.

Missing function or method docstring
pylint(missing-function-docstring)

위 메세지는 해당 함수(function)에 주석 설명이 없어서 발생한다.

아래 문서를 참고하면 보다 효율적인 주석 설명을 기입할 수 있을 것이다.

만약 위 메세지가 보기 싫다면, '''으로 간단히 주석만 남겨도 사라진다.

 

Python - 함수 주석 설명 유용한 팁 3가지 (asecurity.dev)

 

Python - 함수 주석 설명 유용한 팁 3가지

프로그램이 길어지고 호출해야 하는 함수가 다양한 파일에 존재한다면, 함수 호출을 위해 도움을 줄 수 있는 설명을 달아주는 것이 효율적이다. 여기서는 함수 설명을 어떻게 달 수 있는지와 알

asecurity.dev

 

반응형

댓글0