問題タブ [self-documenting]

次のサンプルは、「Dive into python」本からの引用です。

このサンプルは MP3FileInfo の文書化を示していますが、MP3FileInfo にヘルプを追加するにはどうすればよいですか。タグデータマップ

McConell のCode Completeを読んでいて、ブール変数を使用してコードを文書化する方法について説明しています。たとえば、次の代わりに:

彼は次のように提案しています。

これは、論理的で、良い習慣であり、非常に自己文書化されているように思えます。ただし、この手法に出くわしたことがほとんどないため、この手法を定期的に使用することをためらっています。珍しいという理由だけで混乱するかもしれません。しかし、私の経験はまだそれほど多くはないので、このテクニックについてプログラマーの意見を聞くことに興味があります。また、誰かがこのテクニックを定期的に使用しているか、コードを読むときに頻繁に見たことがあるかどうか知りたいです。これは採用する価値のある規則/スタイル/テクニックですか? 他のプログラマーはそれを理解して評価するでしょうか、それとも奇妙だと思いますか?

ライブラリを開発して文書化する場合..すべてのソースファイルからのすべての関数/データ構造を文書化しますか、それともパブリックヘッダーに表示されるパブリックのものだけを文書化しますか？

私は2番目のオプションに傾いています、これは大丈夫ですか？

読書でこの言葉に出会いました。コンテキストは次のとおりです。

「T-SQL コードを自己文書化することをお勧めします。一般的に言えば、ビューの列名が SELECT ステートメントで指定され、ビューに個別にリストされていない場合、ビューはより自己文書化されます。」

これが何を意味するのか、私はただ興味があります。どんな反応でも大歓迎です。

ユーザーが送信したデータが検証され、いくつかの予備的な統計テストが実行され、結果のワークスペースがさらなる分析のために統計学者に送信されるワークフローを開発しています。

一部のシナリオでは、RData ファイルは、それまでプロジェクトに精通していなかった統計学者に送信されます。RData ファイルを開いて、プロジェクトを要約したメッセージ、開いたワークスペースに何が含まれているかを示すメッセージ、および詳細情報を検索できる URL を表示できるようにしたいと考えています。

問題は、コマンドを実行したりパッケージをロードしたりする統計学者にできるだけ頼らないようにしていることです。私が思いついた最高のものはこれです（RDataファイルの作成中）：

次に、your_output.RData は、統計学者が R セッションから開くファイルです。

これは、統計学者がある種のインターフェイス (ESS など) に "ls" を入力させるのではなく、コンソールで "ls" と入力することを前提としているため、最適ではありません (エラーが発生する可能性もあります)。また、使い勝手の良さからしても基本的な機能をいじるのは大雑把に感じます。

私が考えたもう 1 つのことは、README をカスタム クラスにして、それと共に S3 印刷メソッドを RData ファイルに保存することですが、すべての人が完全なオブジェクトをすぐにコンソールに出力するわけではありません。私はおそらくそれを試しclass()てみるだろうしhead()、他の人が最初に何をするかは誰にもわからない.

コマンドのドキュメントには次のように書かれてい.First()ます（強調は私のものです）...

関数 '.First' (および '.Last') は、適切な '.Rprofile' または 'Rprofile.site' ファイルで定義するか、'.RData' に保存することができます。

...しかし、既に実行中のセッションから RData ファイルを開くと、.First()実行されません。

誰かが最小限のユーザー入力で、できれば何も入力せずに RData ファイルを開いたときに、1 回限りのメッセージを表示する方法を知っている人はいますか?