大声でコードを読み取るための基準?


12

誰でも、どの言語でもコードを読み上げるための標準を定義していますか?これは、視覚障害者向けのスクリーンリーダーなどのソフトウェアにとって重要だと思います。この種のことは、コードを誰かと話し合ったり、グループでレビューしたり、クラスを教えるときにも起こります。

C言語ファミリーには、「明白な」発音を持つ単語がたくさんあります。いくつかは単に英語の単語です:forbreakcasedefault、などいくつかの略語、のようなint、あいまいでありません。そしてがありcharます。

私はいつも「炭」の最初の音節のようにそれを言う(そして頭で聞く)傾向があります。「車」のように発音した人と初めてコードについて話していたとき、それは私を不快にさせましたchar。しかし、それを知っていても、炭としての炭は私にとってより適切だと感じています。

そして、次のようなステートメントがありfoo = bar ? *(++baz) : zardozます。

誰もが(彼らの意見では)正しい方法を声に出してコードを読むことを指示する文書を作成しましたか?特定の言語向けか、一般的なコード向けか?


9
Perlを大声で読む... <おお、痛み>
ルーク

4
好奇心だけのために、なぜコードを読み上げるのですか?私はそれをやったことがないと思う
ビトーのPy

1
これは、通勤中にプログラムを口述するのにも役立ちます。幸いなことに、Delphiプログラムであるため、非常に優雅に口述するだけです。
ピーターターナー

2
@ピーター:好奇心から、どのように発音し:=ますか?
メイソンウィーラー

2
@メイソン幸いなことに、コロンは等しい
ピーターターナー

回答:


15

クイックカバーオール:Coding Horrorでこのすばらしい記事を読んでください

電話でコードを議論するときはいつも、文字通りそれを読むことはありません。それを人間に「コンパイル」する必要があり、行の反対側にまだ混乱がある場合は、より文字通りの読みに向かって進むことができます。たとえば、私はあなたの例を次のように読みます

「barがtrueの場合、bazポインターをインクリメントし、そのアドレスの値をfooに割り当てます。そうでない場合は、fooをzardozに設定します。」

私は90年代半ばからフルタイムの在宅勤務者でした。そのため、同僚とのやり取りは事実上すべて電話またはその他の間接的な手段で行われてきました。多くの場合、スクリーン(端末)またはVNC(X)セッションのいずれかを共有しています。通常の仲間とは別に、私たちはコード、設計、計画などについて一日中話します。

コードについて話すときは、作業中のプロジェクトのタイプに深く関係する専門用語を使用します。新しいグループメンバが完全に機能するようになるまでに時間がかかる(多くの)理由の1つは、新しい部門/会社に参加するたびに基本的に新しい言語を学習しているためです。

上で言ったように、そして他の人が言ったように、私たちはどんな議論にも適切なレベルで話そうとします。しかし、時々、あなたは本当に誰かに「これをタイプしてください」と言う必要があります。

なんて言うの?さて、次のような列挙を与えることができます...

~  tilde
`  backtick
'  single quote
"  quote (or double quote)
/  slash, \ is backslash
#  pound or hash
!  bang (or exclamation mark)
@  at
$  dollar
%  percent or mod
^  caret or xor
&  and or bitwise and
&& and or logical and
|  pipe or 'or' or bitwise or
|| 'or'
*  value of, times, glob, multiplied by
() parens, open paren, close paren
{} braces, curlies, open stash, close stash
[] brackets, square brackets, at & sub (for subscript) (for C-ish arrays)
...

これがまさにこれらのキャラクターの「私たち」の言い方です。「#」と言う範囲全体のアイデアを得るには、#のWikiページをご覧ください。

そのため、変動が多すぎます。それはあなたがコーディングしている言語に固有でなければなりません(私たちが人間とのコミュニケーションのためにこれを英語で入力しているように)。

言語の文脈がなければ、文字のつづりによって常に文字に戻す必要があります。だから、私が知っているほとんどの人は、言語標準が物事を呼んでいるものすべてにフォールバックします。

SELECT COUNT(*) INTO x FROM ...   (SQL)
X IS Y + 1                        (Prolog)
(setq x 40)                       (Emacs lisp)
/def x 40                         (PostScript)
x = 40                            (C)
$x = 40                           (Perl)

これらのそれぞれは、適切なコンテキスト内で「Set X to ...」と言うだけで暗示されます。しないでくださいでも、私は、「文字列Xが文字列Yに等しい」と読まれているもののコードを始めます。

「hash bang bin bash」または「shebang bash」と言うと、ほぼ全員が「#!/ bin / bash」を意味することを知っています。そうでない場合は、「ハァッ」と言い、「ファイルの先頭:ポンド記号、感嘆符、スラッシュ、ビン、スラッシュ、バッシュ、改行」というノッチを下げます。それでも得られない場合は、もう一度降ろします。「目の前にあるキーボードを見てください。「3」キーを見てください。Shiftキーを押したときの上部のマークはポンド記号です。」

結論:

  • あまり心配しないでください、あなたは間違っているでしょう、誰もがそれを乗り越えるでしょう
  • それはあなたが何をするのか正確に具体的すぎる
  • いつもタオルを持っています
  • Coding Horrorの記事を読んでください

同意する。「単語ごとに」というコードを読むことはほとんどありません。それが何をしているのかを説明するだけです。

1
あなたの目標は、何が起こっているのかを説明することなのか、それを逐語的にコピーすることなのでしょうか?
ジョブ

1
@Job-モジュール、クラス、ブロック、サブなどを説明するだけでなく、実際にコードを読んでいる場合は、ある程度の特異性が必要です。しかし、私は決して舌でタイプしようとはしませんでした。誰かにメールアドレスや電話番号を大声で伝えるのがどれほど難しいか考えてみてください。実際に文字ごとに綴ることになった場合は、視聴者に完全に依存します。チルダを「波打つ」と呼ぶ必要がある場合は、そうしてください。
-unpythonic

マークは、私はあなたが書いたもの(リテラルの精度を切り札が多いという意味)に同意するが、それは本当に呼び出すどのような事項に同意のプロセスについて本当に私の質問に対処しません#!。電話でコードについて話し合う理由を言うことすらありません。投票数が最も多いので、さらに回答を具体化できますか?
ベンザド

更新に時間を割くだけでなく、Jeff Atwoodのブログにリンクしました。このブログは、The New Hacker's Dictionaryの「ASCII」のエントリにリンクしています。探していました。ありがとう!
ベンザド

3

私は、言語の構文を大声で話すための標準に出会ったことがありません。「#!/ bin / sh」を「ハッシュスラッシュビンスラッシュSH」と呼び、「ポンドの感嘆符フォワードスラッシュBINフォワードスラッシュSH」ではなく、誰かが自分の個人的な好みを表明する小さなスニペットに出くわしました「後者は、リスナーが構成体にあまり精通していないと仮定するかもしれません。

また、異なる言語が大声で読み込める量にも大きな格差があります。たとえば、大きな声で話しやすい傾向があるPythonと、多くの句読点を言うか、「$ var [20]」から「配列varの20番目の要素」に変換する必要があるPerlとの違いを考えてみましょう。

私自身の経験では、コードを声に出して読む必要がある理由、リスナーの知識レベル、問題の言語に基づいて非常に文脈に依存しています。

コードレビューの場合、声を出して読むよりも声明を説明する方が一般的です。通常、生のコードをリスナーに読むよりも意味や思考プロセスを理解することが重要だからです。

誰かにCコードの正確な行をエディターに入力させようとすると(たとえば、下級プログラマーの肩越しに見て、コードの行を修正する方法を確認します)、しばしばコードを話すようになります「スペースがオープンパレンnullの二重二重pクローズパレンの場合」などのキーワードと記号で、より上級の開発者との同じ交換は、「ここでpがnullであるかどうかを確認する必要があります... 」


1

コードについて話すことは、擬似コードが非常に便利になる時代の1つです。

誰かがキャラクターによってコードを私に与え始めたら、私に彼らに私にそれを電子メールで送るように伝えて、私が思うことを彼らに知らせます。


0

短い答え

標準の発音ガイドに最も近いものは、The Hacker's Dictionary(別名The Jargon File)の「ASCII」のエントリのようです。これには、「Usenet ASCII発音ガイドのリビジョン2.3」から派生した表が含まれており、オンラインでは簡単に発見できなくなりました。1991年5月から6月にかけて、関連するディスカッションスレッド「Name that character!」がありcomp.miscます。スレッドは、「&」の「Donald Duck」などの「巧妙な」名前が新しいドキュメントから省略されたことに注目しています。

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