1
PyCharms TODOファインダで遊んでいただけです。それは素晴らしい機能であり、私はそれをより強烈に使用したいと思います。しかし、私がdocstringで使っているtodoのエントリは見つかりません。PyCharmにdocstrings内のTodoアイテムを見つける方法
"""
Do something.
:todo: This is my Todo-Item that is sadly not found
"""
# Todo: When I use line comments it is found.
def my_function():
pass
docstringのToDo項目を見つけるためにPyCharmを設定する方法はありますか？私はそれを得た場合
私は本当にポイントを参照してくださいいけません。 TODOをdocstringに入れたいのですが？ –
私はtodoのエントリを置くのが良い場所のようです。また、スフィンクスは.. todo ::ディレクティブでマークされた項目をサポートしています。 – MrLeeh
私はその悪い習慣だと思います。ドキュメントの文字列は、 'コードの特定のセグメントを文書化するために、コメントのように使われるコード'の定義でなければなりません。しかし、TODOは、自分自身や同僚のための指標であり、そのセグメントの仕組みではなく、セグメントと何をするべきかを示します。 –