파이참(pycharm)에서 주석으로 항목 관리하기

주석은 코드에 설명을 기록할 수 있어 유용한 기능이다. 자신이 작성한 코드도 1~2개월 뒤에 보면 어떻게 작성한건지 잘 기억이 나지 않는다. 그래서 주석을 잘 작성하는 것도 좋은 코드를 작성하기 위한 요소이다. 파이참에는 주석을 활용하여 코드를 더 효율적으로 관리할 수 있는 기능을 제공한다.
오늘은 파이참에서 주석으로 항목 관리하는 방법에 대해서 알아보도록 하겠다.

 

 

파이참 주석으로 항목관리

파이참에는 주석으로 TODO항목을 관리할 수 있는 기능이 있다. TODO를 기록하고 항목별로 탐색이 가능하여 유용하게 쓸 수 있다.

TODO항목만 관리하려고 하니 조금 아쉬움이 남는다. 다른 항목들도 작성하고 관리하고 싶다면, 파이참에는 항목들을 추가하는 기능들을 제공하고 있다.

 

설정에 들어가서 [Editor] - [TODO]에 가면 TODO와 같이 항목을 추가할 수 있는 화면이 나온다. 상단의 Patterns에 있는 '+' 버튼을 클릭하고, Patterns에 원하는 패턴을 입력해보자. 필자는 \bproc\b.*을 입력해 보았다. 아래 메뉴를 이용해서 색깔도 변경하고 대소문자 구별도 가능하다.

 

패턴 추가 등록

 

이제 아래와 같이 #proc이라고 작성하며 색깔이 변경되고, TODO와 같이 관리되는 것을 알 수 있다. 

 

TODO 항목 추가

 

터미널 아래 도구창에서도 리스트로 관리되는 것을 알 수 있다.

TODO 항목리스트 조회

 

새로 만든 TODO항목만 관리하고 싶다면 좌측의 깔데기 모양 아이콘을 클릭해보자. Editor Filters를 클릭하면 필터를 만들어 원하는 TODO만 조회할 수 있다. 새로 나온 창에서 아래 Filters에 '+'버튼을 클릭한다. 원하는 패턴을 선택하고 이름을 작성한다.


이제 다시 좌측의 깔데기 모양 아이콘을 클릭하면 방금 만든 필터를 확인할 수 있다. 이 필터를 선택하면 원하는 TODO항목만 조회가 가능하다.

원하는 항목만 조회하기

 

오늘은 이렇게 파이참에서 주석으로 항목 관리하는 방법에 대해서 알아보았다. 파이참에는 파이썬 코드를 효율적으로 작성할 수 있도록 해주는 다양한 기능들이 있다. 이러한 기능들을 숙지하면 좀 더 쉽게 코딩을 할 수 있다.