에디터를 처음에 파이썬을 접했을 때부터 파이참을 써오다가 1차 프로젝트를 시작하면서 vs-code로 바꾸었었다. 왜 바꿨는지는 기억이 잘 안 난다. 전부 visual studio code 를 쓰길래 그냥 바꾸었었던 것 같다...😅
덕분에 컨벤션을 다 잊었던 것 같다..😭
브랜디 협업을 나가고 첫 코드리뷰 때 컨벤션에 대한 피드백을 많이 해주셨다. 컨벤션 같은 크리티컬한 이슈는 없애는 게 좋다고 하시면서 자세히 설명을 해주셨었다. 파이참을 쓰게 되면 자동으로 컨벤션이 틀린 부분을 잡아주기 때문에 써보라는 조언과 함께:) 그래서 그날로 바로 파이참으로 다시 바꾸었고 코드를 짤 때 컨벤션을 신경을 쓰게 되는 나를 발견했다. 오늘도 팀장님께서 코드가 많이 깔끔해졌다고 칭찬을 해주셔서 기분이 너무 좋았다. 칭찬욕심이 많은 나는 표정관리가 안되고...ㅋㅋㅋ🤣
컨벤션과 마찬가지로 주석을 안써버릇했어서 (나쁜 버릇ㅠㅠ..) 그 부분도 피드백을 받았다. 코딩을 할 때는 나 외의 사람 또는 내가 나중에 다시 보게 되더라도 이게 무슨 함수인지 이 로직은 왜 이렇게 짠건지 등등 알아보기 쉽게 주석을 달아주는 것이 좋다고 하셨다. 그리고 오늘 docstring 에 대해 가르쳐 주셨고 지금까지 작성한 모든 코드에 독스트링을 적용해 주석추가를 완료하였다👍🏼
Docstring - 문서화
docstring은 모듈, 함수, 클래스, 메소드 정의의 최상단에 위치하는 문자열이다. 주석의 일종이지만, 컴파일 타임에 제외되는 # 주석과 다르게 하나의 특수 속성이 된다. 컴파일 타임에 제외되지 않기 때문에 하나의 문서가 된다. docstring에는 함수에 대한 설명, 파라미터 정보, 반환값에 대한 정보가 포함되어 있다. 이를 통해 각 파라미터에는 어떤 타입의 값을 전달해야 하는지, 함수가 어떤 작업을 하고, 어떤 값을 반환하는지 등을 바로 이해할 수 있다.
파이참의 설정 부분에 가면 docstring 종류를 확인하고 설정할 수 있다.
아래의 3가지가 가장 많이 쓰인다고 하시면서 세가지를 직접 보여주셨는데 나는 구글이 제일 깔끔하고 맘에 들어서 구글이 제일 괜찮아 보인다고 했는데 팀장님께서도 제일 좋아하는 docstring 타입이라고 하셨다😆
함수 밑에 """ 을 입력후 엔터를 치면 자동으로 형식이 생기고 그곳에 입력을 하면 된다.
이런식으로 함수에 대한 설명, 파라미터에 대한 설명, 리턴값에 대한 설명을 하였고 함수에 마우스를 갖다대면 문서화되어서 나온다. 신기방기😃
파이참 넘나 좋은것....👍🏼
앞으로도 컨벤션과 주석은 계속 신경쓰도록 해야겠다🙌🏻
