[Python]TODO 주석 활용법 (feat. 주석 키워드)

이번 포스팅에서는 TODO 주석을 활용하는 방법에 대해 알아보겠습니다.

 

1. TODO:

# TODO: 해야할 작업
class Leffe():
    pass

TODO라는 키워드를 활용하여 해야할 작업이라는 표시를 정할 수 있습니다. 

이와 비슷하게 프로그래머들 사이에서 널리 사용되는 주석의 키워드를 몇가지 더 알려드리겠습니다.

 

2. FIXME:

# FIXME: 오작동을 일으킨다고 알려진 코드
class Leffe():
    pass

오작동을 일으킨다고 알려진 코드에 적용할 수 있습니다.

 

3. HACK:

# HACK: 아름답지 않은 해결책
class Leffe():
    pass

해결책이 깔끔하지 않은 경우에 적용할 수 있습니다.

 

4. XXX:

# XXX: 이곳에 큰 문제가 있다
class Leffe():
    pass

큰 문제가 포함된 코드의 경우에 적용할 수 있습니다.