問題タブ [comments]

このインターフェースがあるとします

そしてこのクラス

基本クラスまたはインターフェイスの各メンバーのコメントを自動的に挿入できる方法またはツールはありますか?

派生サブクラスごとに同じコメントを書き直すのは嫌いだからです!

常識的には、Doxygen コメント ブロックは、クラス、構造体、列挙型、関数、宣言があるヘッダー ファイルに配置する必要があります。これは、ソースなしで配布されることを意図したライブラリ (オブジェクト コードを含むヘッダーとライブラリのみ) の妥当な議論であることに同意します。

しかし...私は、完全なソースコードで使用される社内の (または自分自身のサイドプロジェクトとして) ライブラリを開発しているときに、正反対のアプローチを考えていました。私が提案するのは、実装ファイル (HPP、INL、CPP など) に大きなコメント ブロックを配置して、ヘッダーで宣言されたクラスと関数のインターフェイスが乱雑にならないようにすることです。

長所：

• ヘッダー ファイルの混乱が少なくなり、関数の分類のみを追加できます。
• たとえば、Intellisense の使用時にプレビューされるコメント ブロックは衝突しません。これは、.H ファイルに関数のコメント ブロックがあり、同じ .H ファイルにそのインライン定義がある場合に見られる欠陥です。ただし、.INL ファイルから含まれています。

短所：

• (明らかなもの) コメント ブロックは、宣言があるヘッダー ファイルにはありません。

それで、あなたは何を考え、おそらく提案しますか？

wiki にコメント セクションを作成しようとしています。「コラム」の作成を含む Web 上の 1 つの解決策がありますが、それはメインの記事ブロックの下に 2 番目のテキスト ブロックを作成するだけのようです。後続の編集では新しいコメントが作成されないため、これは実際的ではありません。既存のコメントを編集するだけのように見えます。他にもこの質問をする人が何人かいます。誰かが前にこのようなことをしたことがありますか?

副作用のあるコメントがある言語は? 本質的に、コメントではないコメント....

コードにコメントを付けるときによくあるジレンマの 1 つは、引数名をマークアップする方法です。私が何を意味するかを説明します：

さて、これに関する私の問題は、引数名vector、widthおよびnがそのコメントでまったく区別されておらず、単純なテキストと混同される可能性があることです。その他のオプション:

「幅」に収まるように「ベクトル」を変形します。「n」以下

または多分：

-vector- を -width- に収まるように変形します。-n-以下

あるいは：

:vector: を :width: に収まるように変形します。:n:以下

あなたは要点を理解します。Doxygen のようないくつかのツールはこれを強制しますが、ツールを使用しないとどうなりますか? この言語は依存していますか?

何を使うのが好きですか?

背景: VS 2008 を使用しており、TFS 2005 から 2008 にアップグレード中です。

いくつかのプロジェクトを含むソリューションがあり、全体で数百のコード ファイルがあります。これらすべてのファイルに同じテキストをコメントとして追加します (著作権メッセージ)。これを行うための迅速/簡単/効率的な方法を知っている人はいますか? また、すべてのファイルをチェックアウトおよびチェックインする必要がないように、TFS 経由でこれを行う方法はありますか?

これを行うマクロの作成に関する CodeProject のコードをいくつか見つけましたが、各ファイルを個別に開いてから、各ファイルでマクロを実行する必要があり、これは回避したいと考えていました。

ありがとう。

クリンゴン語についてのばかげた思索がこの記事に端を発した後、Lua バイトコードにコンパイルされるクリンゴン語プログラミング言語を作成する愚かな趣味のプロジェクトを始めました。言語設計の初期段階で、クリンゴン プログラマーに関する情報を調べたところ、次のクリンゴン プログラミング ルールが見つかりました。

真のクリンゴン戦士は自分のコードにコメントしません!

だから私は自分の言語はコメントをサポートしないと決めた.

現在、クリンゴンの方法の多くは、私たち人間のプログラマーには合理的ではないように見えますが、私の趣味の言語の設計と実装に手を出しているうちに、コメントに関するこのクリンゴンのルールは、素晴らしいとまではいかなくても、実際には非常に合理的であることに気付きました。

プログラミング言語からコメントする機能を削除したということは、例外なく、文芸的なコードを書かなければならないことを意味していました。

それで、コメントをサポートしていない言語が世の中にあるのではないかと思いました。

言語からコメントを削除しないことについて、本当に良い議論はありますか?

編集：必要なコメントの良い例はありますか?

PS> 上記の私の趣味の言語はとにかく部分的にばかげているので、一般的に必要なコメントの概念と同じくらい、私の実装にあまり集中しないでください.

私はスタック オーバーフローのコメント UI がとても気に入っています。同じことを自分の Web サイトに実装することを検討しています。コードを調べたところ、ここでの主なツールはWMDであり、JQuery TextArea Resizerが補助的な役割を果たしているようです。

WMD は、クライアント側で Markdown を HTML に変換します。プレビューに役立つのでとてもいいのですが、それをサーバーに送信するときに問題が発生します。検証エラーが発生した場合 (たとえば、ユーザーがコメント フォームの他の部分に無効な電子メール アドレスを入力したか、名前を入力しなかったなど)、サーバーはエラー メッセージを含むフォームを再表示して応答します。フォーム フィールドは事前入力されています。サーバーが Markdown を見たことがないため、コメント テキストは Markdown ではなく HTML になりました。しかし、それはユーザーが入力していたものなので、Markdown にしたいと思います。

ここに何かアイデアはありますか？

私はさまざまなアイデアを検討しました：

• サーバー側でHTML から Markdown への変換を行います。このアイデアについてはそれほど興奮していません。Markdown から HTML を再び Markdown に変換するのはばかげているように思えます。ユーザーとして、ソフトウェアがテキスト/コードを再フォーマットするときはいつもイライラします。
• クライアント側の検証 (もちろん保持するサーバー側の検証を強化するため)。現在、コメントフォームでreCAPTCHAを使用していますが、合理的な方向のように思えます。つまり、少なくともreCAPTCHA部分をサーバーに投稿する必要があります。
• WMD を失い、MarkdownJ を使用してサーバー上で Markdown を HTML に変換します。プレビュー機能を実現するための他のメカニズムを探す必要がありますが、これは維持したいと考えています。

理想的には、テキストの Markdown バージョンを取得し、それを HTML に加えてサーバーに送信する方法があればよいのですが、それが実際に可能かどうかを知るには、私は JavaScript の専門家ではありません。

任意の提案をいただければ幸いです。

次の形式のコメントを削除する必要がありました。

先頭と末尾の「区切り文字」の間のすべて (改行を含む) に一致する正規表現を使用したいと考えています。

このタスクに適した正規表現は何でしょうか?

OK、トリプルクォートの文字列が複数行のコメントとして機能する可能性があることは承知しています。例えば、

と

しかし、技術的に言えば、これらは文字列ですよね？

私はグーグルでPythonスタイルガイドを読みましたが、複数行の/ **/タイプのコメントが正式に実装されていない理由に対する技術的な答えを見つけることができませんでした。三重引用符を使用しても問題はありませんが、この設計上の決定につながった理由について少し興味があります。