連絡先の詳細をソースコードに残す必要がありますか?


15

私は通常、誰かが後でそれについて質問したい場合に備えて、私のメールアドレスを礼儀として残します。他の人はそれ以上の情報を残していますか?誰も電話番号を残していますか?


7
******いいえ******
ジョエル・イーサトン

1
@Joel-******地獄番号******私は世界に解き放ったコードのいくつかを覚えており、誰かに10年後のことを思い出させるのではなく、忘れようとするWTFをお願いします!= P
jmq

回答:


28

私は自分の名前もメールアドレスもほとんど残さない:

  • コピーペーストされる傾向があります(ええ、悪い習慣です)。そして、私が書いていないコードのために私に連絡する人々になります
  • コードが変更されると、連絡先情報は削除も更新もされません。そして、あまりにも多くの変更が加えられたコードについて私に連絡することになります。

代わりに、人々にコードリポジトリ(SVN、Git、...)を参照することを好む:そこで、彼らは完全な履歴を持つことができます-そして、誰が質問についての部分を書いた/修正したかを見つけます。


6

私は自分の名前やイニシャルをコメントヘッダーに残し、リビジョン番号と変更の簡単な説明を付ける習慣があります。

これはバージョン管理と冗長であるという事実を考えると、最近その習慣から抜け出しました。たとえば、誰がどの変更を加えたかに興味がある人はバージョン管理でソースコードの履歴全体を見ることができます。


あぁ!NetBeansにデフォルトのテンプレートについて不平を言うとき。
ジオボルジェ

5

ソフトウェアを専門的に開発している場合は、おそらくバージョン管理システム(svn、hg、gitなど)を使用しています。この場合、プロジェクトでコードをコミットできるコーダーアカウント(その情報を持っている)を既に持っているため、コード内に個人情報を残すことは冗長であると思います。

ただし、オープンソースコミュニティの一部の人々は、連絡先に名前とメールアドレスを残すのが面白いと感じています。これはまったく悪い考えではありません。この例を確認してください:

FFmpegから:

/*
 * Interplay C93 video decoder
 * Copyright (c) 2007 Anssi Hannula <anssi.hannula@gmail.com>
 *
 * This file is part of FFmpeg.
 */

DirectFBから:

/*
   (c) Copyright 2001-2009  The world wide DirectFB Open Source Community (directfb.org)
   (c) Copyright 2000-2004  Convergence (integrated media) GmbH

   All rights reserved.

   Written by Denis Oliver Kropp <dok@directfb.org>,
              Andreas Hundt <andi@fischlustig.de>,
              Sven Neumann <neo@directfb.org>,
              Ville Syrjälä <syrjala@sci.fi> and
              Claudio Ciccani <klan@users.sf.net>.
*/

3

しかし、確かに私の名前やメールを残すと、コードにコメントを書くことになったのでしょうか?申し訳ありませんが答えではありませんでした。実際には、通常doctypeコメントを残します...

/**
* @author PurplePilot
* @package
* @etc
*/

メールアドレスではなく私の名前で。はい、このコードは切り取って貼り付けることができますが、コピー機が著者名を変更しない場合、他の何も変更せず、メンテナンスされていないコメントであることが明らかになります。

時々使用するメールsigがあります

/* Anything you put in comments is not tested and easily goes out of date. */

これは、このスレッドの他の多くの投稿の一般的な反映のようです。ただし、主題に関するルールはないため、プログラマーは最も快適に感じることを行う必要があります。


えっと...何?これはコメントだったはずです。
アダムリア

2
@アンナ-えーと。冗談だと思う。
オコド

@Slomojoうん、わかった。それでも、コメントとしてはより適切だと思います。それはかわいいですが、答えはありません。
アダムリア

@Anna、おそらくそうだろうが、それを読んだとき、それは質問に対する答えとして働く。
オコド

2

私はしばしばイニシャルをコメントに残します(適切な場合)が、それ以上残す理由は見当たりません。私がまだコードを所有している会社で働いているなら、人々は私と連絡を取る方法を知っているべきです。

会社を辞めて別の場所で仕事をしている場合、最後の会社(競合他社になる可能性があります!)でソフトウェアに関する電話をかけていると、新しい雇用主にとって公平ではありません。

コードが他の方法で共有された場合(たとえば、オープンソース、オンラインで投稿された場​​合)、連絡先の詳細を入力する価値がある可能性がありますが、コードが別の方法で渡された場合、あなたに与えた人はすでにあなたの連絡先の詳細、そしてあなたが何年も前に書いたコードについて尋ねるランダムな見知らぬ人が本当に欲しいですか?


理にかなっている会社の中です。私はパブリックドメインにリリースされたコードをもっと考えていました。

1
公にリリースされたコードについては、ヘッダーにある名前/ url / email以外はたぶんしません。おそらく一意の電子メールエイリアスを使用するので、オンラインで公開されたためにメールがスパムになった場合、メールをフィルタリング/ブロックできます。
ダニータッペニー

2

次のような考え方があります:ソース管理に含めるべきソースコードを入れないでください。

時間の経過とともに、多くの人がコードをファイルの粒度未満で変更するため、著者情報はこれらの1つです。非難ログは、あなたが知る必要があるすべてをあなたに伝えるべきです。

そうは言っても、多くの企業は元のファイル作成者をリストし、それを決して変更しないという移行に従っています。(人々が会社を去るとき)それが本当に役に立つかどうかは分かりません。

主な価値は意識を高めることだと思います。IDEに行って、表示された各ファイルの作成者を尋ねるのではなく、グループのコードベースでこれらのファイルに出会うことで、プロジェクトの責任と専門知識を得ることができます。

パブリックドメインの場合、利点は「広告」です。欠点は、将来誰かがファイルを破壊する可能性があるが、それでも名前が残っていることです。


2

30年にわたるソフトウェアのプログラミングと保守、変換の後、ソースコードの著者情報は無価値であると断言できます。

私はそれを一度も使ったことがありません。信頼できません。まだ会社に雇用されている人はいません。名前の半分は請負業者です。


2

連絡先の詳細をコードに残さない。それは常に時代遅れになり、解決するよりも多くの問題を引き起こすようです。

他の人々は問題のかなりの数を指摘しました、しかし、私は最も陰湿な効果であると思うものに言及したかったです。

チームの作業とコードの品質を損なう可能性があります。

どのように尋ねるかもしれませんが、それはすべて集合的なコードの所有権に関係しています。コードの名前を入力すると、次に来る人は「それは私のコードではありません、私はただXになります」と言います。もちろん、コードに名前を付けたいのは、彼らがそれを改善したからです。しかし、あなたは、このコードに数週間を費やし、10分を費やしたのはなぜでしょうか?時間が経つにつれて、このサイクルは続き、人々は誰がコードの信用(または非難)を得るべきかについて議論します。

チームにとってはうまく機能しません。代わりに、チームが集合的な所有権に焦点を合わせ、所有権なしですべてのコードを優れたものにする場合、システムの品質である本当に重要なことに集中できます。誰が作業したかを追跡する必要がある場合は、いつでもVCSを使用して詳細を取得できます。

注:特に開発者が他の貢献者ほどアクティブでない場合、開発者の名前がある場合、著作権ヘッダーでさえもこの破壊的な影響を与える可能性があります。そのため、オープンソースプロジェクトでは、著者の著者のみに言及しようとするか、貢献者はプロジェクトの1つの場所にファイルを記載するだけです。


1
あなたの問題は、コメント自体よりも心の悪い同僚に起因していると思います。
ジェイ

素晴らしい答えです。一部のオープンソースプロジェクトは、コードの集団所有権を破壊しているため、ファイルに著者情報を書き込むことさえ禁止しています。
エティエンヌ

1

VCSが私の説明責任を果たすので、連絡先情報をソースコードに残さない傾向があります。

とはいえ、コードを使用する人がフィードバックを提供するためにあなたに直接連絡できるように、連絡先情報をどこかに持っておくことをお勧めします。READMEファイル内のプロジェクトWebサイトへのリンクは、一般的には良い習慣です。

この規則は、ソースコードを共有するためにUsenetとIRCが定期的に使用された時代に由来します。コードがVCSからリンクされることはほとんどなく、より頻繁に直接送信されるため、フィードバックが必要な場合は、連絡先情報をどこかに含める必要があります。


1

ほとんどの場合、ソース管理からではなくデータベースから直接取得されるため、SQLスクリプトに名前を残します。

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.