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

休業。この質問は意見に基づいています。現在、回答を受け付けていません。 この質問を改善してみませんか？この投稿を編集して、事実と引用で回答できるように質問を更新してください。 2年前休業。 この質問を改善する インターフェースとその実装の間でコメントを自動的に同期する方法はありますか？現在、両方を文書化していますが、手動で同期を維持したくありません。 更新： このコードを考えてみましょう： interface IFoo{ /// <summary> /// Commenting DoThis method /// </summary> void DoThis(); } class Foo : IFoo { public void DoThis(); } このようなクラスを作成すると： IFoo foo=new Foo(); foo.DoThis();//comments are shown in intellisense ここではコメントは表示されません： Foo foo=new Foo(); foo.DoThis();//comments are not shown in intellisense <inheritDoc/>タグは完全に砂の城のドキュメントを生成しますが、それはインテリセンスのツールチップでは動作しません。 あなたのアイデアを共有してください。 …

98 c#  documentation  xml-documentation 

休業。この質問は意見に基づいています。現在、回答を受け付けていません。 この質問を改善してみませんか？この投稿を編集して質問を更新し、事実と引用で回答できるようにします。 2年前休業。 この質問を改善する 常識では、Doxygenコメントブロックは、クラス、構造体、列挙型、関数、宣言があるヘッダーファイルに配置する必要があります。これは、ソースなしで配布されることを意図したライブラリ（ヘッダーとオブジェクトコード付きのlibのみ）の健全な議論であることに同意します。 しかし...私は、会社の内部（または私自身のサイドプロジェクト）のライブラリを開発するときに、その完全なソースコードで使用される、まったく逆のアプローチを考えていました。私が提案するのは、ヘッダーで宣言されたクラスと関数のインターフェースを混乱させないために、実装ファイル（HPP、INL、CPPなど）に大きなコメントブロックを配置することです。 長所： ヘッダーファイルの乱雑さが減り、追加できるのは関数の分類のみです。 たとえばIntellisenseが使用されるときにプレビューされるコメントブロックは衝突しません-これは、.Hファイルに関数のコメントブロックがあり、同じ.Hファイルにそのインライン定義がある場合に観察された欠陥です。 .INLファイルから含まれています。 短所： （明白なもの）コメントブロックは、宣言があるヘッダーファイルにはありません。 それで、あなたは何を考え、そしておそらく提案しますか？

97 documentation  comments  doxygen 

Pythonでいくつかのクラス継承を実行しようとしています。各クラスと継承されたクラスに適切なdocstringが必要です。継承したクラスについては、次のようにしたいと思います。 基本クラスのdocstringを継承します おそらく関連する追加のドキュメントをdocstringに追加します クラス継承の状況でこの種のdocstring操作を行う（おそらくエレガントまたはpythonic）方法はありますか？多重継承についてはどうですか？

97 python  inheritance  documentation 

閉まっている。この質問はスタックオーバーフローのガイドラインを満たしていません。現在、回答を受け付けていません。 この質問を改善してみませんか？Stack Overflowのトピックとなるように質問を更新します。 4年前休業。 この質問を改善する 2015年8月の更新： Pinterestがここで提供していますhttps://dev.pinterest.com/ v2 Pinterest APIに関する公式または非公式のドキュメントはありますか？ 私が知っていること： JSON apiはバージョン2です。https： //api.pinterest.com/v2は json応答を返します モバイルアプリとベータ開発者がいるため、人々はそれに反対してプログラミングしています SOのピントレスト認証の質問 KellanによるGithub上のv2の更新を含むv1のPHPラッパー、メソッド：アップロード、ピン留め、ピン留め、ボード、アクティビティ、人気-Kellanのコードの読み取りは、私が見つけた最高の情報です Kellanの作品に関する詳細とPinterestチームからの回答 非公開のFacebook Pinterest Devグループ Pinterestの裏にあるスターの一部を紹介します 更新2014年3月4日 Pinterestは、アクセスをリクエストできるベータv3 APIを発表しました。ページを下にスクロールすると、左の列にエンドポイントが一覧表示されます。 https://developers.pinterest.com/api_docs/ 2013年1月9日更新https://api.pinterest.com/v2は404を提供する ため、v3に移動されたようです。 https://api.pinterest.com/v3 { "status": "failure", "code": 11, "host": "053", "generated_at": "Wed, 09 Jan 2013 10:25:27 +0000", "message": "API method not found.", "data": …

96 json  api  mobile  documentation  pinterest 

JavaDocを使用して、クラスの最後の静的フィールドの値をどのように参照できますか？ 私が欲しい???、この例では、フィールドの値に置き換えSTATIC_FIELD。 /** * This is a simple class with only one static field with the value ???. */ public class Simple { /** * We can reference the value with {@value} here, * but how do we reference it in the class JavaDoc? */ public static final String STATIC_FIELD …

96 java  documentation  javadoc 

閉まっている。この質問は、StackOverflowのガイドラインを満たしていません。現在、回答を受け付けていません。 この質問を改善したいですか？質問を更新して、StackOverflowのトピックになります。 3年前に閉鎖されました。 この質問を改善する 私はパンダに不慣れで、使用しようとしていますdate_range。のfreqようなBME、あらゆる種類の良いものに出くわしBMSました。適切な文字列をすばやく検索して、必要なものを取得できるようにしたいと思います。昨日、ドキュメントのどこかで適切にフォーマットされたテーブルを見つけましたが、テーブルのタイトルが非常に鈍いため、今日は検索を使用して再度見つけることができません。

96 python  pandas  documentation  dataframe  frequency 

クローズ。この質問はもっと焦点を合わせる必要があります。現在、回答を受け付けていません。 この質問を改善したいですか？質問を更新して、この投稿を編集するだけで1つの問題に焦点を当てるようにします。 2年前に閉鎖されました。 この質問を改善する 私はDoxygenがCまたはPHPコードのドキュメントを作成するのが好きです。私は今後のPythonプロジェクトを持っていますが、Pythonには/* .. */コメントがなく、Pythonのように文書化する独自の自己文書化機能もあることを覚えていると思います。 私はDoxygenに精通しているので、それを使用してPythonドキュメントを作成するにはどうすればよいですか？特に気をつけなければならないことはありますか？

94 python  documentation  doxygen  docstring  python-sphinx 

休業。この質問は意見に基づいています。現在、回答を受け付けていません。 この質問を改善してみませんか？この投稿を編集して、事実と引用で回答できるように質問を更新してください。 2年前休業。 この質問を改善する をR使用するパッケージがありますroxygen2。にはいくつかのCコードが/srcあり、私はDoxygenでの作業を始めたところです。ドキュメントを組み合わせる方法、またはコンパイルをroxygen2と統合する方法はありますか？Cコードドキュメントを配置する場所の「ベストプラクティス」はありますか？ roxygen2とdoxygenのグーグルは主にroxygenにつながり、doxygenの結果と似ています。Doxyfilesを含むパッケージをいくつか見つけましたが、一貫した組織がありません。たとえば、lme4は、ソースディレクトリの外部inst/doc/Doxyfileと呼ばれるフォルダーに出力します。MatrixのルートディレクトリにもDoxyfileがあります（以前のリリースではにありました。このドキュメントもパッケージディレクトリの外にエクスポートされます）。doxygenlme4inst Cパッケージ内にドキュメントを含めない理由はありますか？または、広く使用されているにもかかわらず、Rパッケージ内でDoxygenがあまり使用されないのはなぜCですか？ 更新：関連するroxygen2機能リクエストを参照

91 c  r  documentation  doxygen  roxygen2 

現在のところ、この質問はQ＆A形式には適していません。私たちは回答が事実、参考文献、または専門知識によってサポートされることを期待しますが、この質問はおそらく議論、議論、投票、または拡張された議論を誘います。この質問を改善でき、再開できると思われる場合は、ヘルプセンターにアクセスしてください。 8年前に閉鎖。 最も人気のある軽量マークアップ言語を特定し、それらの長所と短所を比較してください。これらの言語は、ドキュメンテーションなどの技術的な散文の汎用マークアップである必要があります（たとえば、Hamlはカウントされません）。 参照：MarkdownとReStructuredText

90 documentation  markdown  markup  restructuredtext  textile 

コード（Javadoc）の文書化の一環として、深いインデントを使用して要素間の関係を示したいとします。 ネストされたリストを次のように作成するにはどうすればよいですか？ いくつかの要素 他の要素 まだいくつかの他の要素

88 documentation  javadoc  indentation  nested-lists 

現在のところ、この質問は私たちのQ＆A形式には適していません。回答は事実、参考資料、または専門知識によって裏付けられることを期待していますが、この質問は、討論、議論、世論調査、または広範な議論を求める可能性があります。この質問を改善し、場合によっては再開できると思われる場合は、ヘルプセンターにアクセスしてガイダンスを入手してください。 7年前に閉鎖されました。 Android用のオフラインドキュメントが見つかりません。誰かがリンクを提供できますか？

83 android  documentation  offline 

NodeJSにQライブラリを使用するなど、promiseオブジェクトを返すコードがいくつかあります。 var Q = require('q'); /** * @returns ??? */ function task(err) { return err? Q.reject(new Error('Some error')) : Q.resolve('Some result'); } JSDocを使用してそのような戻り値を文書化する方法は？

83 javascript  node.js  documentation  jsdoc  promise 

notepad ++と崇高なコーディングで何年も幸せに過ごした後、PHPIDEを試してみるようにアドバイスされました。phpStormを試していますが、良さそうです。コードの完成とドキュメント化は素晴らしい機能ですが、魔法のメソッドを使用するとうまくいきません。phpStormに魔法のメソッドで何が起こっているのかを理解させるための回避策はありますか？ 私たちの状況は次のようなものです。 abstract class a { public static function __callStatic($method,$args) { if(strpos($method,"get_by_") === 0) { //do stuff } elseif(strpos($method,"get_first_by_") === 0) { //do stuff } elseif($method == "get_all") { //do stuff } } } class b extends a { // some more stuff } b::get_by_user_id(27); b::get_first_by_id(156); b::get_all(); 魔法のcallStaticメソッドを使用すると、関数呼び出しを構成する1つ以上の引数を介してオブジェクトのコレクションを取得できます。 これらの場合に使用する@methodステートメントがあるようですが、phpStormはこれらのステートメントの最初のものだけを取得しています。さらに、戻り値の型を混合に設定できるのは、これが呼び出されたクラス（私の例ではb）として設定できるようにしたい場合のみです。 …

81 php  documentation  phpstorm  magic-methods  docblocks 

閉まっている。この質問は、StackOverflowのガイドラインを満たしていません。現在、回答を受け付けていません。 この質問を改善したいですか？質問を更新して、スタックオーバーフローのトピックになります。 3年前に閉鎖されました。 この質問を改善する これは非常に簡単な質問ですが、Googleで何も見つかりませんでした。Node.jsのサーバー作成関数のリクエストパラメータに関するドキュメントを探していますが、何も見つかりませんでした。 http.createServer(function(request, response){ console.log(JSON.stringify(request)); }); JSON.stringify（）を使用してデバッグすると、オブジェクトが循環していてプログラムが停止するというエラーが発生します。私のような別のものを見てきたrequest.url、あるいはrequest.body、しかし、要求機能とパラメータのすべてを文書化するページがありますか？見つけやすいはずなのに、見つからないようです。 もう一度試してみましたが、console.log(request)リクエストからすべてのデータを書き出すだけでした。ここにそれはちょうど参照としてあります： ondata: [Function], _httpMessage: { domain: null, _events: [Object], _maxListeners: 10, output: [], outputEncodings: [], writable: true, _last: false, chunkedEncoding: false, shouldKeepAlive: true, useChunkedEncodingByDefault: true, sendDate: true, _hasBody: true, _trailer: '', finished: false, _hangupClose: false, socket: [Circular], connection: [Circular] } …

80 node.js  documentation  request 

閉まっている。この質問は、StackOverflowのガイドラインを満たしていません。現在、回答を受け付けていません。 この質問を改善したいですか？質問を更新して、スタックオーバーフローのトピックになります。 6年前に閉鎖されました。 この質問を改善する それに直面しましょう：デフォルトのJavadocが見苦しいことを確認するために、デザイナーである必要はありません。 Web上には、スタイルを変更したJavadocを提供するリソースがいくつかあります。ただし、デフォルトの動作は製品を表しており、適度に見栄えがよいはずです。 もう1つの問題は、Javadocの使いやすさが他の同様のリソースと比較して最新ではないという事実です。 特に巨大なプロジェクトは、Firefoxのクイック検索を使用してナビゲートするのは困難です。 実用的な質問： ブラウザよりも使いやすい方法で既存のJavadocを参照できるスタンドアロン（デスクトップ）アプリケーションはありますか？ Monoのドキュメントブラウザのようなものを考えています。 理論的な質問： Javadocを何らかの形で標準化された方法で進化させる計画があるかどうか、誰か知っていますか？ 編集： このトピックに関するSunのwikiへの便利なリンク。

80 java  documentation  javadoc