私はソースコードのための良いドキュメントが好きですが、私はコード内のドキュメンテーションのコメントが嫌いです。私は、コードを他の言語のドキュメントから分離するソリューションを見つけましたが、Rustでは解決しませんでした。ですから、ソースコードとRustのドキュメントを分離するためのソリューションはありますか?Rustのドキュメントコメントとソースコードを分けることはできますか?
答えて
私は恐れがあります。私はRustの生態系に従っています。私はそういったことについて一度も言及していません。関連するノートでは、コメントはコード内にあるべきだと思うし、Rustにオープンソースコードを書いていれば、他の人々のために、標準的なやり方を忠実に忠実にすることをお勧めします。例えば。私はスペースとは対照的に、タブのインデントを鮮明に主張しています(「タブでインデントし、スペースに合わせて」)。しかし、Rustコミュニティは(明らかに劣って:)スペースに定住しているので、私はRustプロジェクトでスペースを使用します。それは私の好みに合っていませんが、それを乗り越えた後は、私と他の人たちが協力するときに楽になります。
回避策として、私は編集者に積極的にコメントを表示させることをお勧めします。
それは本当に残念です!テスト、コード、ドキュメントなど、すべてのコーディング要素を分離したいからです。私は、コードに文書を書くための規約を理解していません。複雑な関数のコメントは役に立ちますが、ドキュメンテーションのコメントは役に立ちません。私はそれがコードを読むことができないと思う。それにもかかわらず、大変感謝しています。 –
@ NarabX文書化された文書の近くにドキュメンテーションを置くことで、最新のものにすることができます。誰かが関数のシグネチャを変更し、その関数をドキュメント内で更新するのを忘れてしまうのは簡単に想像できる。この問題は、ドキュメントが関数の2行前にある場合に緩和されます。また、あまりにも多くのドキュメントでコードを読むことができない場合は、デフォルトでドキュメントのコメントを折りたたむようにテキストエディタを設定してください:) – mcarton
@mcarton私の言うことを理解していますが、経験があれば、機能の前に)、時々私は好みのテキストエディタにアクセスすることができません。したがって、コメントを折り畳むことは良い回避策ですが、それは私が望むものではありません。ご意見ありがとうございます。 –
- 1. Rustでプライベート変数を作ることはできますか?
- 2. `multirust`はどこにRust言語のソースコードをインストールしますか?
- 3. erlangのソースコードに行番号を付けることはできますか?
- 4. Rustのドキュメントコメントの2つのスタイルの違いは何ですか? (///対//!)
- 5. jasmineがrake jamine:ciで自分のソースコードを見つけることができないのはなぜですか?
- 6. WebViewのUIスレッドとHTTPスレッドを分けることはできますか?
- 7. XAMLページをデザイナとxamlのウィンドウに分けることはできますか?
- 8. Emacsでミニバッファとエコー領域を分けることはできますか?
- 9. Rustコンパイラが 'std'のクレートを見つけることができません
- 10. このWebページのソースコードを解析することはできますか?
- 11. どこでソースコードを読むことができますか?
- 12. Rustでグローバル変数を使用することはできますか?
- 13. GHCの言語拡張のソースコードはどこですか?「矢印」ですか?私は、ソースコードを見つけることができます
- 14. RustにC列挙型をラップすることはできますか?
- 15. テンプレートをC++の引数から分けることはできますか?
- 16. sinatraのソースコードでメソッドのルートを見つけることができません
- 17. Hammerspoonで `init.lua`を別のコンポーネントに分けることはできますか?
- 18. イメージを任意の色で分けることはできますか?
- 19. Rustでオブジェクトを効率的に値で返すことはできますか?
- 20. gerrit.hyperledger.orgからソースコードをチェックアウトすることができません
- 21. Rustの借用コンテンツから移動することはできません
- 22. コンポーネントとサービスをどのように分けることができますか?
- 23. テキストをリストとどのように分けることができますか?
- 24. このコアデータをどのように分けることができますか?
- 25. 私はPHPのmysqlソースコードのサンプルと反応するjsを見つけることができます
- 26. 解析HTML、ソースコード、私はこのページの一部のHTML部分を解析しようとしていますが、私は、ソースコードをチェックするとき、私はこれを見つけることができません
- 27. awkは空のフィールドを分けることができますか?
- 28. どこからcpコマンドのソースコードを見つけることができますか?
- 29. プログラムでJavaソースコードをメモリ内でコンパイルすることはできますか?
- 30. pyinstallerアプリケーションからpythonソースコードを取得することはできますか?
ドキュメントを別にしたい場合は、Rust専用ではないツールで個別に記述することはできませんか? –
できます。あなたはそのための良いツールを知っていますか? –
良いツールがたくさんありますが、それらは個人的な好みに非常に特有です。それはもはや本当に錆問題ではありません。 :-) –