web-dev-qa-db-ja.com

コードコメントで「内部略語」を使用する必要がありますか?

コメント内で「内部略語/スラング」を使用する必要があります。つまり、プロジェクト外の略語やスラングの人々は、たとえば、//NYIの代わりに//Not Yet Implementedのようなものを使用すると、理解が困難になる可能性がありますか?

これには、タイプする「コード」が少なくなる(省略形でオートコンプリートを使用することもできます)、Not Yet ImplementedのようなものよりもNYEのようなものの方が速く読めるなどの利点があります。略語とその(省略されていない)意味を認識している。

私自身、これが私だけが確実に開発者になるプロジェクトでない限り、私はこれに注意します。

3
Anto

いいえ、コメントをコードの一部として扱います。コードは、それを読むことになっている人には明確に理解できるはずです。そのため、意味を推測する必要がある場合は何も使用しないでください。明快さは簡潔さを上回ります。

20
Ian

番号。

プログラマーは入力せず、通信します。 「入力するコードが少ない」ということは、考慮する価値のある要素ではありません。代わりに、@ Carnotaurusが示唆しているように、コードの明瞭さと読みやすさを向上させる方法を検討してください。

8
Rein Henrichs

DW for data warehouseのようにinternalリソースに共通の省略形または俗語がある場合、誰でも問題ないようです。少なくとも文化的には、略語に同意します。

しかし、Not Yet ImplementedNYIのような外部の略語やスラングは、時間の経過とともに急速に変化し、流行に左右される傾向があるため、LOLのような同じカテゴリに分類されます。 NYIは、Not Yet Startedの場合はNYSNot Yet Releasedの場合はNYRと同じくらい簡単です。

5
Philip Regan

私の意見では、略称がプロジェクトチームのメンバーの間でよく知られている場合は、コードのコメントでそれを使用しても問題ありません。

OTOH、あなたが唯一の開発者であり、それがあなたの個人的なプロジェクトではない場合、またはチームメイトがそれが何を意味するのかわからないことがわかっている場合は、それを使用しないでください。

4
M.Sameer

ドメインで一般的な略語のみを使用します。金融では、EBITDAを特定するための多くのリソースがあります。開発チームの外でさえプロジェクトに関与するほとんどの人はそれを理解するでしょう。長所と短所はありません。

私は言語の略語にも熱心ではありません。 cn(少なくともコードサンプルでは)を接続とし​​て使用するのが一般的ですが、それについてもう少し知りたいと思います。

3
JeffO

このような略語を使用する理由の適切な例は、あなた自身の例です。 「NYI」を意味するときに「NYE」と入力しました。だからあなたは大晦日について人々に話しているようです。ただし、「まだ実装されていない」と入力した場合でも、スペルができないと思っているだけで、アイデアは得られます。

コーディングは人種ではないので、「キーストロークを節約する」ことは本当に有効な考慮事項ではないと思います。演習の目的は、簡潔で理解しやすいコードを書くことです。これは、コード内の「必要な」コメントにまで及びます。略語の解析。それが言っていることを読むよりも少しだけ負担がかかります(これは基本的に何の努力もせずに自動的に行います)。

1
Adam Cameron