問題タブ [documentation]

「open」、「read」、「write」などの関数を呼び出すために、オペレーティングシステムがユーザースペースからカーネルに移行するために使用するシステムコールメカニズムの優れた入門書または技術的な説明を探しています。

ウィキペディアのエントリ以外に何かありますか？ウェブサイト、PDF、本、ソースコード、すべて大歓迎です:)

ActionScript ファイルを文書化するように DoxyGen を構成するにはどうすればよいですか?

*.as および *.asi ファイルを dox​​ygen の検索パターンに含めましたが、クラス、関数、および変数がそこに表示されません。

誰かがC＃3.5でActiveRecordイントロサンプルを試しましたか？どういうわけか、サンプルが完全に間違っているか、単に古くなっているように感じます。XML構成はまったく間違っています。

する必要があります：

（nhibernateの構成構文を正しく理解している場合..）

私は何が間違っているのだろうと思っています。ユーザーモデルでCount（）を呼び出すと、「ユーザーに対してExecuteQueryを実行できませんでした」という例外が発生します。

これが何であるかわかりません。チュートリアルのソースは、ページのソース（特にXML構成）とは大きく異なり、ほとんどの場合（ジェネリックなどは含まれていません）、構文が異なるVS2003サンプルです。

助言がありますか？ActiveRecordは素晴らしく見えます。

私はJavaから来ているPythonから始めています。

クラス、そのメソッド、およびその使用方法の例を見つけることができるJavaDocAPIに似たものが存在するかどうか疑問に思いました。

Python（コマンドライン）からhelp（thing）を使用するのに非常に役立つことがわかりました

私はこれも見つけました：

http://docs.python.org/2/

https://docs.python.org/2/py-modindex.html

しかし、探しているクラス名がすでにある場合は役立つようです。JavaDoc APIにはすべてのクラスがあるので、何かが必要な場合は、必要なものに「似ている」クラスまでスクロールダウンします。または、すべてのクラスを参照して、それらが何をしているのかを確認することもあります。機能が必要なときは、脳が私 を思い出します。javadocで似たようなものが覚えているのを見ました！？

しかし、Pythonでは（まだ）似たようなものは見つからないようです。そのため、このクエストを投稿しています。

ところで、私は最終的にこれを読むことを知っています：

https://docs.python.org/2/library/

しかし、まあ、今日ではないと思います。

以下は、今後の C++ プロジェクトで提案されています。

• Sutter と Alexandrescu による C++ コーディング標準
• JSF Air Vehicle C++ コーディング標準
• C++ スタイルの要素
• Scott Meyers による効果的な C++ 第 3 版

他に選択肢はありますか？または、上記のリストは C++ プロジェクトで使用する必要がありますか?

いくつかの関連リンク

• ソフトウェア会社は開発者にコーディング スタイルを課すべきだと思いますか?
• https://stackoverflow.com/questions/66268/what-is-the-best-cc-coding-style-closed

ruby コードを書いていて、標準の Date 型を使用して現在の日付を取得したいとします。検索エンジンを使用する代わりに、このクラスのドキュメントをすばやく見つける方法はありますか? と入力して Date のメソッドを取得できることはわかっていますが、Date.methods私が知る限り、引数の型や戻り値に関する詳細は提供されていません。

編集者固有の回答を歓迎します。私が選んだエディタは Emacs です。

ユーザー マニュアルを書いている人は、必ずしもプログラマーである必要はなく、ビジュアル エディターが必要です。主な問題は、オーサリング ツールの内部形式です。読み取り可能な text/html である必要があるため、バージョン管理にチェックインされた個々のページのバージョンを簡単に比較できます。

少し前に、私たちのプロジェクトの 1 つのドキュメント Web サイトを生成するためにSandcastleを使い始めました。非常にうまく機能していますが、私たちは常にプロジェクトのクラス、メソッド、プロパティ (...) のドキュメントのみを作成し、プロジェクト全体とプロジェクトのパーツ/モジュール/名前空間のドキュメントを完全に分離していました。そのドキュメントをまとめて、生成されたヘルパー ファイルにそれぞれのドキュメントを追加できればいいのですが、その方法がわかりません。

名前空間宣言にコメントを追加するだけでは機能しないようです (C#):

誰もこれを行う方法を知っていますか? どういうわけかそれが可能であることを知っています、そしてそれがあれば本当にいいでしょう... :)

他の人に自分のコードにコメントするよう説得するための良い議論は何ですか?

多くのプログラマーが、自分自身や他の人のためにドキュメントを残すよりも、コメントなしでコードを書くことの認識速度を好むことに気付きました。私が彼らを説得しようとすると、「メソッド/クラス名はそれが何をするかを示すべきだ」などの生半可なことを聞​​くようになります。

コメントに反対の場合は、コメントを残してください。これは、他の方法ではなく、コードにコメントするよう人々を説得しようとする人々のためのリソースであるべきです. :-)

その他の関連する質問は次のとおりです: Commenting code , Do you comment your codeおよびHow would you like your comments .

100% よく知らない API を使用するコードを作成または管理しているとします。

特定の呼び出しターゲットのドキュメントを読むかどうか、また読むのにどれくらいの時間を費やすかをどのように決定しますか? 読まないってどうやって決めるの？

(HTML ドキュメントを開くか、ソース コードを調べるか、IDE のホバー メカニズムを使用して、それを読むことができると仮定しましょう)。