常用註解：# TODO、# FIXME 的意義與使用方法

程式設計有些慣例用字，讓程式設計師在閱讀其他人的程式碼時，能夠透過這些慣用字，快速理解他人程式碼，並且迅速了解自己的任務或目標為何。 以下將介紹用來標記未完成工作的兩種常用註解：# FIXME 與 # TODO。

# FIXME

意義：

在發現錯誤時，可能無法立即解決，此時就可以使用這個註解來標註錯誤。
優先級較高，通常標示於較嚴重或需要優先被修正的錯誤。

用法

# FIXME: 這裡可以寫一些你關於這個 bug 或 error 的紀錄。
'''
這段是你有錯的程式碼。
'''

# TODO

意義：

在發現需要修改的內容時，可能無法立即解決，此時就可以使用這個註解來標註要修改的地方。
優先級低於 # FIXME。

用法

# TODO: 這裡可以寫一些你關於這個需要修改的內容的紀錄。
'''
這段是你要修改的程式碼。
'''

實用範例：

以下這段程式碼有以下兩點要修正：

1. 一個嚴重的邏輯錯誤，導致無窮迴圈產生 → 使用 # FIXME。
2. 有一個小部分可以調整，讓顯示對使用者更友善 → 使用 # TODO。

hungry = True

# FIXME: eatFood = 0 應該要在這邊。
while hungry:
    eatFood = 0
    eatFood += 1
    if eatFood > 5:
        # TODO: 加入一個 print() 告訴使用者我吃飽了會比較好。
        break

Eclipse 中快速檢視 # FIXME、# TODO 的方法：

1. Eclipse 上方工具欄選擇 Windows > Show View > Markers
2. 在下方 Console 那區會出現表格，展開 Task 就可以看到 # FIXME 與 # TODO 的註解。
3. 點擊註解就可以直接連結到那個註解所在位置。
4. 未來有需要時，可以直接在 Console 那區的工具列點擊 Markers 檢視。