TODO and FIXME comments must have ownership

문서 > 코드 분석 > Static Analysis Rules > TODO and FIXME comments must have ownership

이 페이지는 아직 한국어로 제공되지 않으며 번역 작업 중입니다. 번역에 관한 질문이나 의견이 있으시면 언제든지 저희에게 연락해 주십시오.

Metadata

ID: python-best-practices/comment-fixme-todo-ownership

Language: Python

Severity: Notice

Category: Best Practices

Description

When using TODO or FIXME, specify who write the annotation. It’s a best practice to remind you who created the annotation and have potential context and information about this issue.

Non-Compliant Code Examples

# TODO fix this function
def my_function():
    pass

# FIXME fix this function
def my_function():
    pass

# FIXME(): fix this function
def broken():
    pass

Compliant Code Examples

# TODO(bob) fix this function
def my_function():
    pass

# FIXME(julien) fix this function
def my_other_function():
    pass

# FIXME[julien] fix this function
def my_other_function():
    pass

# TODO[bob] fix this function
def my_function():
    pass

# TODO (amaan): fix this function
def broken():
    pass

# TODO (amaan.qureshi): fix this function too
def broken2():
    pass