Pycharm의 코딩 지원 기능 3

Annotation (주석)

주석이라는 것이 대단한 기능은 아니지만 코딩할때 대부분의 사람들이 사용을 한다.
rem, //, /* */, # 등과 같은 기호나 문장을 사용하는데 쉽게 말하면 설명이나 사용법등을 기록하는게 일반적이다. 파이썬에는 이러한 것들이외에도 추가적인 기능의 주석문이 있다. #과 함께 TODO , FIXME 가 기본적으로 사용되고 있다. 이러한 코드태그는 java에서도 사용을 하고 있다. ( TODO , FIXME , XXX) 등.
Google C++ Style Guide에서도 TODO에 대한 설명이 나오는데 말하자면 코딩규약이다.
구글의 JAVA 코딩 표준

파이참에서는 TODO에 대한 리스트를 볼수 있도록 지원하고 있다.

TODO의 멀티라인은 다음화면과 같이 들여쓰기를 사용하면 멀티라인의 내용을 하나의 TODO로 인식한다.

파이참에서는 기본적으로 TODO , 'FIXME' 만 정의되어 있다.

Ctrl+'Alt'+'S'를 눌러서 셋팅화면을 호출하면 Editor > TOD 항목이 있다. 해당 화면에서 + 키를 눌러 사용자 정의 코드태그를 입력할 수 있다.

이러한 방식으로 설정을 맞추어서 사용하면 쉽게 코드를 수정하거나 할때 쉽게 찾을 수 있다는 장점이 있다.