なぜ我々はいまだに文字列でコメントを書いているのか - Qiita

あるいは、画像コメントのすすめ。 TL;DR 画像コメントのほうが意図が伝わりやすい 画像URLからツールチップで画像表示してくれるVSCode拡張機能があるよ その場で画像を作るSVGエディタもあったよ 問題提起 みなさんは、少し複雑なアルゴリズムを書くことになったときどうしていますか。 たいていの場合、いきなりコーティングに取り掛かるのでなく、 雰囲気をつかむためメモやホワイトボードに落書きすると思います。 特に幾何計算では簡単なものでも図を描いた方がいいです。こんな感じ。 図を書いたら後はコードに落とすだけです。 ね、簡単でしょう？ // 指定した直線を対称軸としたときの指定した点の鏡映位置を返す function flipVectorByLine(p: Vector, line: Line): Vector { // TODO: よくわかるコメントを書く const ln = ne

[strow0343]

図が必要なほどの情報なら素直に設計書作ってメンテした方が楽。コメントはコード読むのを補助するだけでいい

[dgen]

画像のほうがわかりやすいことは多分にあるが…画像を作るのが億劫。

[Futaro99]

君たち日本語不得意すぎやしないかい

[hinbass]

開発用のタスクとかwikiのリンク貼った方が良くない？（小声）

[likk]

数年後、そこには 404 not found になった画像が!! イメージで説明もしてるし文字列のコメントも無くてもいいか、ってなったら地獄になりそう。

[honeybe]

Base64文字列で画像を埋め込む話かと思ったが違った(ぇ

[odakaho]

良さそうに思ったが、リポジトリ肥大化と検索性の悪さ、オーバーレイ時に下のコードが隠れるとか問題多いな。チケットかwikiへのリンクが無難か。

[kijtra]

Trello とかに詳細書いてURL貼ることはよくあるな。それがマウスオーバーとかでプレビュー出たら最高よね。

[otation]

画像を作るのがめんどくさい。思考を画像化する技術キボンヌ

[ysksy]

メンテを経るごとにコメントとソースの整合性が信用できなくなるのに、画像コメントとか嘘を囁く悪魔にしか見えない。

[keint]

なぜ我々はいまだにキーボードから文字列でプログラミングしているのかとはたまに思う

[yassan0627]

コメントに文字の代わりに画像を使う案

[mygjsi48]

なぜ我々はいまだに文字列でコメントを書いているのか

[sds-page]

ここでインド人を右に

[NOV1975]

設計は設計書に書け

[zu2]

URLを書いて参照できるようにすることはある。整合性問題は何使っても発生するもんなあ

[tmatsuu]

いいね。最近は設定ファイルを書き換える際などにコメントと合わせてリファレンス貼るようにしてる

[pongeponge]

幾何的な物や図示するほうが理解しやすいものは多いもんなぁ

[y-kawaz]

説明が長くなりそうな奴や図で説明したいような奴は、Issue/Wiki/Qiitaとかに好きなだけスクショや図を交えつつ説明書いて、コメントには簡単な説明+詳細はここ見てってURLを書いとくパターンは良くやる。

[knok]

かつてmail headerに画像をエンコードして突っ込むのがあった気がしたけどなんだっけな

[luccafort]

CSSとかのなにをどう変更したのか？をみたいときが稀にあるので選択肢としてあればいいかなーとは思う。ただ画像をコメントに貼り付けるのはなかなか難しい話しではあるかなー。

[souvenir038]

VSCodeにはImage previewという拡張機能があり、画像のURLがあると行番号横やツールチップに画像を表示。ただし画像をリポジトリに含めるとリポジトリが肥大化。

[naari_3]

うーんわからない、記事中に上げられている幾何計算の場合はよく使うものになるんだろうか？

[tuki0918]

発想が良い

[ktanaka117]

これはヨスヨス。AppCodeにこういうのないか探してみよ。

[rryu]

画像はグラフィックエディタ用のファイルや紙などの元となった何かが残ってないと更新しづらくて、それなら普通にドキュメントという形にした方が管理しやすそうというのが私の結論。

[kazuph1986]

“ローカル画像生成サーバ作ってMarkdown記事執筆を加速する”

[tbpg]

"画像コメントのほうが意図が伝わりやすい"

[tarukosu]

コメントに画像を使うの楽しそう

[progrhyme]

"あるいは、画像コメントのすすめ"

[tune]

“画像をリポジトリに含めるとリポジトリが肥大化します。しょうがないね。” これと、画像の再編集がめんどくさくなるだよなー

[tukaelu]

いいかも

[sonots]

SVGコメント書きたい

[ota42y]

おそらく画像を入れるのは本質ではなくて、ソースコードはたぶん何らかの仕様書や頭の中にある何かを具現化したもので、そういった外部のコード以外のものとの連携が弱いってのが問題なのかと

[mamidayo]

おお。はっとさせられた！そうだ！そうだ！ フリーハンドで書き込めるコメント欄をつくろう。 そう僕は誓った。 なぜ我々はいまだに文字列でコメントを書いているのか

[shimaguniyamato]

仕様書と一対一にしようぜ！

[wagyu298]

// グロ画像注意！！！

[mizchi]

履歴管理の概念なさそう

[roirrawedoc]

それほど困ってないから

[yamadadadada2]

一番最初の数学の例はいいなと思ったがそれ以外はあまり有用でないかな。