論文の概要: The Paradox of Function Header Comments

• arxiv url: http://arxiv.org/abs/2401.07704v1
• Date: Mon, 15 Jan 2024 14:21:13 GMT
• ステータス: 処理完了
• システム内更新日: 2024-01-17 16:59:07.185107
• Title: The Paradox of Function Header Comments
• Title（参考訳）: 関数ヘッダコメントのパラドックス
• Authors: Arthur Oxenhorn, Almog Mor, Uri Stern, Dror G. Feitelson
• Abstract要約: 開発者はヘッダコメントの価値を高く評価し、時間内に投資する価値があると見積もる。 この状況の考えられる結果として、開発者はテンプレートを使用して実際の情報を提供しない無価値なコメントを生成することで、ドキュメントを書く必要がなくなる可能性がある。 GitHub Pythonプロジェクトでこれを21,140ファイルに適用すると、ほとんどの関数は文書化されていないが、ヘッダコメントが書かれた場合、関数シグネチャ以外の追加情報を含むのが普通である。
• 参考スコア（独自算出の注目度）: 0.0
• License: http://creativecommons.org/licenses/by/4.0/
• Abstract: Perhaps the most widely used form of code documentation is function header comments. We performed a large-scale survey of 367 developers to catalog their expectations from such documentation and to chronicle actual practice. Paradoxically, we found that developers appreciate the value of header comments and estimate that they are worth the investment in time, but nevertheless they tend not to write such documentation in their own code. Reasons for not writing header comments vary from the belief that code should be self-documenting to concern that documentation will not be kept up-to-date. A possible outcome of this situation is that developers may evade requirements to write documentation by using templates to generate worthless comments that do not provide any real information. We define a simple metric for information-less documentation based on its similarity to the function signature. Applying this to 21,140 files in GitHub Python projects shows that most functions are undocumented, but when header comments are written they typically do contain additional information beyond the function signature.
• Abstract（参考訳）: おそらく最も広く使われているコードドキュメンテーションは関数ヘッダコメントである。 我々は、367人の開発者を対象に大規模な調査を行い、これらのドキュメントから期待をカタログ化し、実際の実践を記述した。 パラドックス的には、開発者はヘッダコメントの価値を高く評価し、時間内に投資する価値があると見積もっていますが、それでも自分たちのコードにそのようなドキュメントを書かない傾向があります。 ヘッダーコメントを書かない理由は、コードが自己文書化されるべきであるという考えから、ドキュメントを最新に保つべきではないという懸念まで様々である。 この状況の考えられる結果として、開発者はテンプレートを使用して実際の情報を提供しない無価値なコメントを生成することで、ドキュメントを書く必要がなくなる可能性がある。 関数シグネチャとの類似性に基づいて、情報レスドキュメンテーションのためのシンプルなメトリックを定義する。 GitHub Pythonプロジェクトでこれを21,140ファイルに適用すると、ほとんどの関数は文書化されていないが、ヘッダコメントが書かれた場合、関数シグネチャ以外の追加情報が含まれる。

関連論文リスト

• Code Documentation and Analysis to Secure Software Development [0.0]
  CoDATは、さまざまなレベルのコードドキュメント間の一貫性を維持するように設計されたツールである。 Intellij IDEAで実装されている。 私たちは、コードの断片とそれを記述するコメントの間のセマンティックな一貫性をチェックするために、大きな言語モデルを使用します。
  論文  参考訳（メタデータ） (2024-07-16T17:25:44Z)
• LongCoder: A Long-Range Pre-trained Language Model for Code Completion [56.813974784131624]
  LongCoderは自己アテンションにスライディングウィンドウ機構を採用し、グローバルアクセス可能なトークンを2種類導入している。 ブリッジトークンは入力シーケンス全体を通して挿入され、ローカル情報を集約し、グローバルな相互作用を促進する。 メモリトークンは、後で呼び出され、記憶する必要がある重要なステートメントをハイライトするために含まれます。
  論文  参考訳（メタデータ） (2023-06-26T17:59:24Z)
• DocChecker: Bootstrapping Code Large Language Model for Detecting and Resolving Code-Comment Inconsistencies [13.804337643709717]
  DocCheckerは、コードとそれに伴うコメントの違いを検出し、修正するツールである。 コードとコメントの不一致を識別する能力があり、合成されたコメントを生成することもできる。 Inconsistency Code-Comment Detectionタスクでは72.3%の精度で、最先端の新たな結果が得られる。
  論文  参考訳（メタデータ） (2023-06-10T05:29:09Z)
• Generation-Augmented Query Expansion For Code Retrieval [51.20943646688115]
  本稿では,次世代のクエリ拡張フレームワークを提案する。 人間の検索プロセスにインスパイアされた – 検索前に回答をスケッチする。 CodeSearchNetベンチマークで、最先端の新たな結果を得る。
  論文  参考訳（メタデータ） (2022-12-20T23:49:37Z)
• Precise Zero-Shot Dense Retrieval without Relevance Labels [60.457378374671656]
  仮説文書埋め込み(英: hypothetical Document Embeddings, HyDE)は、ゼロショット高密度検索システムである。 我々は,HyDEが最先端の非教師付き高密度検索器であるContrieverを著しく上回っていることを示す。
  論文  参考訳（メタデータ） (2022-12-20T18:09:52Z)
• ReCode: Robustness Evaluation of Code Generation Models [90.10436771217243]
  コード生成モデルのための総合的ロバストネス評価ベンチマークであるReCodeを提案する。 ドクストリング、関数と変数名、コード構文、コードフォーマットのコードに特化して、30以上の変換をカスタマイズします。 ヒトのアノテータでは、摂動プロンプトの90%以上が本来のプロンプトの意味を変えていないことが確認された。
  論文  参考訳（メタデータ） (2022-12-20T14:11:31Z)
• CodeExp: Explanatory Code Document Generation [94.43677536210465]
  既存のコード・トゥ・テキスト生成モデルは、コードの高レベルな要約のみを生成する。 我々は、コードのための高品質な説明記述の基準を特定するために、人間の研究を行う。 タスクのための多段階微調整戦略とベースラインモデルを提案する。
  論文  参考訳（メタデータ） (2022-11-25T18:05:44Z)
• Preprocessing Source Code Comments for Linguistic Models [0.0]
  コメントはソースコードの重要な部分であり、ドキュメントの主要なソースです。 本稿では、GitHubの840の最も人気のあるオープンソースプロジェクトとSriLabデータセットの8422のプロジェクトから引き出されたPythonコメントの内容と品質について検討する。
  論文  参考訳（メタデータ） (2022-08-23T23:44:09Z)
• DocCoder: Generating Code by Retrieving and Reading Docs [87.88474546826913]
  コードマニュアルとドキュメントを明示的に活用するアプローチであるDocCoderを紹介します。 我々のアプローチは一般的に、どんなプログラミング言語にも適用でき、基礎となるニューラルモデルとは無関係です。
  論文  参考訳（メタデータ） (2022-07-13T06:47:51Z)
• API2Com: On the Improvement of Automatically Generated Code Comments Using API Documentations [0.0]
  コメント生成の知識リソースとしてAPI Docs(Application Programming Interface Documentations)を利用するモデルであるAPI2Comを提案する。 このモデルを130,000以上のメソッドからなる大規模なJavaデータセットに適用し,TransformerとRNNベースのアーキテクチャを用いて評価する。
  論文  参考訳（メタデータ） (2021-03-19T07:29:40Z)

関連論文リストは本サイト内にある論文のタイトル・アブストラクトから自動的に作成しています。

指定された論文の情報です。
本サイトの運営者は本サイト（すべての情報・翻訳含む）の品質を保証せず、本サイト（すべての情報・翻訳含む）を使用して発生したあらゆる結果について一切の責任を負いません。