2024/01/14 2

파이썬 Docstring 으로 문서화하기

Introduction Docstring은 파이썬에서 코드 문서화의 중심에 있는 기능입니다. 코드 문서화는 좋은 프로그램의 필수적 요소입니다. 아무리 성능이 훌륭한 코드여도 문서를 잘 갖추지 않는다면 사람들은 사용하지 않을 것 이기 때문입니다. Commenting vs Documenting Code Comment: 주석은 코드를 개발자들에게 설명하기 위해서 사용. "코드는 '어떻게'를 알려주고, 주석은 '왜'를 알려줍니다.” - Jeff Atwood 코드 주석을 작성하는 목적은 계획 및 검토, 코드 설명, 알고리즘 설명, 태깅 등 여러 가지 주석은 구체적인 코드 라인이나 블록 바로 근처에 존재. PEP 8에 따르면 주석은 최대 72자까지여야 합니다. Documenting Code: 코드를 문서화하는 것은..

양양 북카페 카페로그 그리고 원제 스님의 다만 나로 살 뿐

 여행 둘째 날에 양양에 있는 북카페인 카페로그에 갔다. 여행 중에 책을 읽고 싶어서 북카페를 찾던 중 우연히 발견한 곳인데 사방이 숲 뷰여서 책읽기가 정말 좋았다. 좌석은 다양한 종류의 좌석이 있었는데 노트북 할 게 아니라서 숲이 제일 잘 보이고 의자가 편해 보이는 자리에 앉았다. 카페로그 신기한 점은 교과서 협회에서 운영하는 숙소 건물에 있는 카페라는 것이다. 그래서 그런지 책도 많고, 책 읽기 좋은 환경이었다. 우리는 주말 9시 30분 정도에 도착해서 우리가 도착했을 때는 두 팀 정도 밖에 없었는데 10시 30분정도 되니깐 사람들이 쭉쭉 들어왔다. 아 카페 뷰나 시설은 좋았는데 커피 맛이나 빵은 아쉬웠다..ㅠㅠ 카페 로그에서 좋았던 건 멋진 뷰나 커피도 아니고 이 책을 발견한 것이다! 원제라는 스..

일상/정보 2024.01.14
반응형