コメントで数学をどのように説明しますか？
https://stackoverflow.com/questions/819300
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
Russian質問
質問のとおり...
数式は、コードよりも数学表記形式の方が意味があります。コメントに数学を入れられると、私のプロジェクトの読みやすさが向上します。
.NET btw。
解決
このように複数の行を使用するだけです：
// Work out average as: sum (values)
// --------------
// count (values)
//
// and distance between points as:
// _______________________
// / 2 2
// d = \/ (x1 - x0) + (y1 - y0)
//
// and the following function:
//
// 3 2
// f(x) = ax + bx + cx + d
そのために魔法は必要ありません。 ASCIIアートが好きではないですか？
他のヒント
@paxの回答をフォローして、ascii-art / plainテキストを使用して方程式をレンダリングします（ちなみに、pax）：
数学関連の文字のショートカットキーの簡単なリストを次に示します。
＆＃176; （度）-Alt + 0176
＆＃177; （プラス/マイナス）-Alt + 0177
＆＃178; （四角）-Alt + 0178
＆＃179; （立方体）-Alt + 0179
＆＃188; （1/4）-Alt + 0188
＆＃189; （1/2）-Alt + 0189
＆＃190; （3/4）-Alt + 0190
ラテックスを使用しています：単純な場合はとにかくそれを見ることができ、複雑な場合は-最も近いワードプレスウィンドウでカットアンドペーストします。ほとんどの場合、正しく解析されます。
わかりやすいコメントのために、私は通常LaTeXまたはWordの構文に頼ります。ただし、通常はWordです。たとえば、e。＆nbsp; g。 ＆＃946; \ beta より読みやすい。私のソースファイルは通常Unicodeなので、これは問題になりません。また、私はすべての周りにあまりにも多くの中括弧が好きではありません：-）
時々Javadocに飽きて、多くのHTMLを使用してJavadocの数式をきれいに表示できますが、ソースの読みやすさには役立ちません.NETではこちら）。
Paxのサンプルを次のように記述しました
// Work out average as:
// ∑(values)/|values|
// and distance between points as:
// d = √( (x_1 - x_0)² + (y_1 - y_0)² )
// and the following function:
// f(x) = ax³ + bx² + cx + d
Unicodeの添字はめったに使用しませんが、すべてのフォントに含まれているわけではないため、特にコードに適したものではありません：）
もちろん、これはScottGuが前回のPDC（別のスタイルでコメントを表示するためにMEFプラグインを作成した場所）で示したVisual Studioの拡張性に最適なアプリケーションです。
MathML を使用して数学的なコメントを記述してから、そのプラグインをノックアップできます。マークアップを解析し、適切な方程式のように表示します。
これは、あなたの質問に対する本当の答えというよりは空っぽのコメントです。しかし、人々に考えさせるために投稿したいと思いました。たぶん誰かがそれをやるでしょう！ :)
これは、Mattの投稿に対するコメントでしたが、私の評判は低すぎました。 LaTexでも同じようなことをしました。これは、XMLコメントに埋め込まれたLaTeXを解析し、ドキュメントに追加される画像を作成するSandcastleビルドコンポーネントです。 mimeTeXのシンプルなラッパーです。アルファコードは、 http://github.com/cuda/latex-sandcastle/ <で確認できます。 / a>
私にとって、複雑な数学の問題を理解する最も簡単な方法は、いくつかの実数をプラグインし、それをフォローすることです。それがどのように機能するかを思い出すだけでない限り、それがどのように機能するかを読むだけでは十分ではありません。
Nunitテストの使用は、複雑な数学の問題がどのように使用されるかの実用的な例を与えるのに理想的です。おそらく、コメントを使用して、ウォークスルーできる単体テストとそれらの場所を指摘するだけです。
数学的形式のASCIIレンダリングを少し簡単にするために、 asciiTeX があります。 asciiTeXはLaTeXスタイルの方程式を受け入れ、ASCIIアートで出力します。
視聴者が何であるかに留意してください。コメントは、今から数か月後、そして現在（および将来）のチームメイトにとって意味のあるものでなければなりません。したがって、数学表記がすべての人にとって完全に理解できる場合、これは問題ありません。それでも、そのコメントを誰が読むかわからないので、テキスト表現または説明を追加します。
