タグ付けされた質問 「documentation」

最近Pythonの勉強を始めましたが、複数行コメントを実装する方法が見つかりませんでした。ほとんどの言語には次のようなブロックコメント記号があります /* */ これをPythonで試しましたが、エラーが発生するため、これはおそらく正しい方法ではありません。Pythonには実際には複数行コメント機能がありますか？

1157 python  comments  documentation 

Objective Cでは#pragma mark、シンボルナビゲーターでコードのセクションをマークするために使用できます。これはCプリプロセッサコマンドであるため、Swiftでは使用できません。Swiftでこれに代わるものはありますか、それとも醜いコメントを使用する必要がありますか？

936 swift  documentation 

休業。この質問は意見に基づいています。現在、回答を受け付けていません。 この質問を改善してみませんか？この投稿を編集して、事実と引用で回答できるように質問を更新してください。 2年前休業。 Pythonでdocstringsを書くいくつかの異なるスタイルを見てきましたが、公式または「合意された」スタイルはありますか？

888 python  coding-style  documentation  docstring 

現在のところ、この質問はQ＆A形式には適していません。私たちは回答が事実、参考文献、または専門知識によってサポートされることを期待しますが、この質問はおそらく議論、議論、投票、または拡張された議論を誘います。この質問を改善でき、再開できると思われる場合は、ヘルプセンターにアクセスしてください。 7年前休業。 私の同僚には、彼のコードにはコメントは不要で、「自己文書化」であると主張しています。 私は彼のコードを確認しましたが、他の人が作成したコードよりも明確ですが、自己文書化コードが完全かつ有用であり、コメント化および文書化されたコードであることにまだ同意しません。 彼の見方を理解してください。 自己文書化コードとは よくコメントされ、文書化されたコードを本当に置き換えることができますか 十分に文書化され、コメントされたコードよりも優れている状況はありますか コードがコメントなしで自己文書化できない例はありますか 多分それは私自身の制限だけかもしれませんが、それがどのように良い習慣になることができるかはわかりません。 これは議論を意図したものではありません-コメントと文書化されたコードが高い優先度である理由を挙げないでください-これを示す多くのリソースがありますが、それらは私の仲間には説得力がありません。そうでなければ彼を説得するには、彼の見方をより完全に理解する必要があると思います。必要に応じて新しい質問を開始しますが、ここでは議論しないでください。 うわぁ、素早い対応！ここで他のすべての回答と大きく異なる場合を除き、既存の回答をすべて読み、新しい回答を追加するのではなく、回答にコメントを入力してください。 また、自己文書化コードに対して異議を唱えている人たち-これは主に、自己文書化コードエバンジェリストの視点（つまり、肯定的な側面）を理解するのに役立ちます。あなたが話題に留まらない場合、他の人があなたに反対票を投じることを期待しています。

258 documentation  comments 

閉まっている。この質問はスタックオーバーフローのガイドラインを満たしていません。現在、回答を受け付けていません。 この質問を改善してみませんか？Stack Overflowのトピックとなるように質問を更新します。 2年前休業。 この質問を改善する Xcode 5の新機能の 1つは、独自のコードを特別なコメント構文で文書化する機能です。形式はdoxygenに似ていますが、これらの機能のサブセットのみをサポートするようです。 サポートされているコマンドとサポートされていないコマンドを教えてください。 それらの使用法のいずれかがdoxygenと異なりますか？

186 objective-c  documentation  comments  doxygen  xcode5 

だから私はresampleの使い方を完全に理解していますが、ドキュメントはオプションを説明するのに適していません。 したがって、resample関数のほとんどのオプションは、次の2つを除いて非常に単純です。 ルール：ターゲット変換を表すオフセット文字列またはオブジェクト 方法：文字列、ダウンサンプリングまたはリサンプリングの方法、デフォルトは「平均」 オンラインで見つけた多くの例を見ると、ルール'D'、日、'xMin'分、'xL'ミリ秒で実行できることがわかりますが、それだけで見つけることができます。 私は以下のことを見てきた方法について：'first'、np.max、'last'、'mean'、および'n1n2n3n4...nx'NXは、各列のインデックスの最初の文字です。 では、ドキュメントのどこかに、pandas.resampleのルールのすべてのオプションと入力方法が表示されていませんか？はいの場合、どこで見つけられませんでした。いいえの場合、それらのすべてのオプションは何ですか？

184 python  documentation  pandas 

休業。この質問は意見に基づいています。現在、回答を受け付けていません。 この質問を改善してみませんか？この投稿を編集して、事実と引用で回答できるように質問を更新してください。 2年前休業。 この質問を改善する わかりました、それで私はPEP 8とPEP 257の両方を読みました、そして私は関数とクラスのためにたくさんのdocstringを書きました、しかし私はモジュールdocstringに何を入れるべきかについて少しわかりません。少なくとも、モジュールがエクスポートする関数とクラスを文書化する必要があると考えましたが、作成者名、著作権情報などをリストするモジュールもいくつか見ました。優れたpython docstringの例を誰かが持っていますか構造化されていますか？

167 python  documentation  module 

休業。この質問は意見に基づいています。現在、回答を受け付けていません。 この質問を改善してみませんか？この投稿を編集して、事実と引用で回答できるように質問を更新してください。 2年前休業。 この質問を改善する 私は現在Pythonから始めており、PHPのバックグラウンドが高く、PHPではjavadocドキュメントテンプレートとして使用する習慣をつけています。 Pythonのドキュメンテーションjavadocとしての場所があるのか​​と思っていましたdocstring。ここで確立された規則および/または公式のガイドラインは何ですか？ たとえば、Pythonの考え方に合わせるには手の込んだようなものですか、できる限り簡潔にしようとする必要がありますか？ """ replaces template place holder with values @param string timestamp formatted date to display @param string priority priority number @param string priority_name priority name @param string message message to display @return string formatted string """ そして、もし私が少し余りに網羅的であるなら、代わりにこのようなものを使うべきです（ほとんどのドキュメントは__doc__メソッドを通じて印刷されません）？ # replaces template place holder with values …

162 python  documentation  javadoc  docstring 

現在、社内の他の開発者が内部で使用する小さなフレームワークを書いています。 適切なIntellisense情報を提供したいのですが、スローされた例外を文書化する方法がわかりません。 次の例では： public void MyMethod1() { MyMethod2(); // also may throw InvalidOperationException } public void MyMethod2() { System.IO.File.Open(somepath...); // this may throw FileNotFoundException // also may throw DivideByZeroException } 例外を文書化するためのマークアップは次のとおりです。 /// <exception cref="SomeException">when things go wrong.</exception> 私が理解していないのは、によって呼び出され たコードによってスローされた例外を文書化する方法MyMethod1()ですか？ によってスローされた例外を文書化する必要があります MyMethod2() によってスローされた例外を文書化する必要がありますFile.Open()か？ 起こり得る例外を文書化する最良の方法は何でしょうか？

139 c#  .net  documentation  intellisense 

Pythonのドキュメント文字列を使用して、パラメーターを含むメソッドをドキュメント化する方法は？ 編集： PEP 257はこの例を示します： def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real -- the real part (default 0.0) imag -- the imaginary part (default 0.0) """ if imag == 0.0 and real == 0.0: return complex_zero ... これはほとんどのPython開発者が使用する規則ですか？ Keyword arguments: <parameter name> -- Definition (default value if any) …

139 python  documentation  documentation-generation 

閉まっている。この質問はスタックオーバーフローのガイドラインを満たしていません。現在、回答を受け付けていません。 この質問を改善してみませんか？Stack Overflowのトピックとなるように質問を更新します。 12か月前に閉鎖。 この質問を改善する FFmpeg C APIを使用するためのドキュメントを見つけようとしています。コマンドラインのドキュメントしか利用できないようです。 優れたドキュメント/チュートリアル/リンクはありますか？

119 c  api  documentation  ffmpeg 

休業。この質問は意見に基づいています。現在、回答を受け付けていません。 この質問を改善してみませんか？この投稿を編集して、事実と引用で回答できるように質問を更新してください。 6年前休業。 この質問を改善する TeX / LaTeXは素晴らしいです、私はそれを多くの方法で使用します。その利点のいくつかは次のとおりです。 テキストファイルを使用します。これにより、入力ファイルを比較したり、テキストを操作するための多くのツールを使用したりできます。 それは非常に柔軟です レイアウトが安定しています。ドキュメントの最初で何かを変更しても、ドキュメントの最後で他のことに影響しません さまざまな目標を達成するために多くの拡張機能があります（後継者は拡張機能なしで開始しますが、適切な拡張システムがあります） 標準のビルド制御ツールを使用して複雑なドキュメントをサポートできます（dmckeeに感謝） ソリューションをカプセル化し、それらを新しいドキュメントにコピーして貼り付けるか、他の人に送信して学ぶことができます（dmckeeに感謝） しかしその一方で、いくつかの小さなことはそれほど良くありません： 最初は習得が難しい 画像の位置を制御するのは複雑です いくつかのことは少し直感に反しています たまにタイプしすぎる必要があります（begin {itemize} ... \ end {itemize}） それで、LaTeXの後継/代替が存在するか、少なくとも開発中の代替の有望な候補はありますか？実際の後継者/良い代替案は、長所を維持し、短所を修正するか、少なくともそれらのいくつかを修正します。

118 documentation  latex  tex 

休業。この質問は意見に基づいています。現在、回答を受け付けていません。 この質問を改善してみませんか？この投稿を編集して、事実と引用で回答できるように質問を更新してください。 2年前休業。 この質問を改善する 私は、その属性がパブリックにアクセスできるように意図され、特定のインスタンス化で時々オーバーライドされるだけの軽量クラスを書いています。Python属性には、クラス属性のdocstringや、あらゆる種類の属性を作成するための規定はありません。これらの属性を文書化するために期待され、サポートされている方法は何ですか？現在、私はこのようなことをしています： class Albatross(object): """A bird with a flight speed exceeding that of an unladen swallow. Attributes: """ flight_speed = 691 __doc__ += """ flight_speed (691) The maximum speed that such a bird can attain. """ nesting_grounds = "Raymond Luxury-Yacht" __doc__ += """ nesting_grounds ("Raymond Luxury-Yacht") The …

115 python  class  documentation  docstring  class-attributes 

JSDocでは、特定のタイプの配列（文字列の配列など）がある場合、私が見つけることができる最良のドキュメントは次を使用することを示しています。 /** * @param {Array.<string>} myStrings All my awesome strings */ function blah(myStrings){ //stuff here... } 以下の疑問符をどのように置き換えて、オブジェクトの配列を指定しますか？ /** * @param {???????} myObjects All of my equally awesome objects */ function blah(myObjects){ //stuff here... }

105 javascript  documentation  jsdoc 

APIドキュメントの関数インターフェイスの構文を解釈するための標準はありますか？ある場合、それはどのように定義されますか？ アイテムの色を変更する方法の例は、「fillColor」関数用のPhotoshopのJavaScriptスクリプトガイドです。 fillPath ([fillColor] [, mode] [, opacity] [, preserveTransparency] [, feather] [, wholePath] [, antiAlias]) 括弧の意味は何ですか？括弧内にコンマがあるのはなぜですか？これは次の呼び出し例とどのように関連していますか？ myPath.fillPath(myNewColor) myPath.fillPath(mynewColor, { mode: RGB, opacity: .5 })

102 api  documentation