Python docstring のレイアウト (""" """と
さまざまなレイアウトのドキュメントストリングを見てきました...など...
"""
@DESCRIPTION
Ive seen tags STARTING with an at-sign
:DESCRIPTION:
Tags with colons
DESCRIPTION
And tags with nothing
"""
これらのいずれかに機能作用がありますか? @Elixir と関連付けられていますか? それとも、これらは開発者の単なる好みですか? docstring のスタイル ガイドを調べましたが、そのようなことに対処している場所がわかりません...
ありがとう！
docstring をドキュメントに変換したい場合は、追加のマークアップを追加して、使用しているドキュメント ツールが追加の書式を適用できるようにすることができます。
は、Epydocフィールド@を示します。
セミコロン:はスフィンクスの最初のものです (スフィンクスのドキュメントまたは上記のリンクを参照してください)。
ここに関連する投稿があります: What are these tags @ivar @param and @type in python docstring?
他の用途があるかもしれません (Elixir を含む可能性があります。これは、私がコメントできるほどよく知っているテクノロジではありません)。
それが役立つことを願っています。