C言語の全角文字コメント行がコンパイルエラーを起こすことがある - 生物物理計算化学者の雛
エラーを引き起こすコメント行 とあるＣ言語のプログラムを Windows 上の Visual Studio 2008 で編集・作成し、完成したソースコードを Linux マシンにコピーし gcc でコンパイルしてデータ処理を実行という流れで作業を行っていました。 その際に、ある全角文字を含むコメント行が存在するとエラーが生じるという現象に遭遇しました。 このエラーを再現するプログラムは以下のようなものです。 #include <stdio.h> int main(void) { int n = 10; // n の値により分岐可能 if(n > 5){ printf("Large\n"); }else{ printf("Small\n"); } return 0; } このソースコードは、Visual Studio上では何の問題もなくコンパイル、実行できます。 しかしながら、Linux の
docstringのテンプレートを出力してくれるautoDocstringのVS Code拡張が素敵だった - Qiita
Pythonの関数（メソッド）の内容に合わせてdocstringのテンプレートを生成してくれるautoDocstringというVS Codeの拡張機能をお仕事とプライベートで使っていたら結構気に入ったのでその紹介です。 autoDocstringでできること Pythonの関数やメソッドの引数名や型アノテーションなどに応じたdocstringのテンプレートをVS Code上で生成してくれます。 ※JSDoc的なもの含め、他の言語だと割とその辺をしっかり生成してくれる一方でPythonだと（出力されるdocstringのスタイルがずれていたりなど）個人的にしっくりくるものが無く、今まではスニペット的にクリップボードへ定型文登録などして過ごしていました。 PEP257やGoogleスタイル、NumPyスタイルなどメジャー所のdocstringのスタイルはサポートされています。 ※そもそもdoc
A Philosophy of Software Design 後半
2022/6/22 @ MoneyForward 勉強会 で実施した A Philosophy of Software Design の話です。
URLだけでOK！どんなWebサイトもコメント付きでシェア可能な「MarkUp」を使ってみた！ - paiza times
どうも、まさとらん（@0310lan）です！ 今回は、URLを入力するだけであらゆるWebサイトの好きな箇所にコメントを付けて、不特定多数の人とシェアできるWebサービスをご紹介します！ Webサイトのデザインや機能について、チーム内だけでなくさまざまな人と意見交換したいときに活用できるサービスになっています。 使い方に関しては究極にシンプルな設計なので、誰でもすぐに利用できるのも大きな魅力でしょう。 【 MarkUp 】 ■「MarkUp」の使い方 それでは、実際に「MarkUp」をどのように使うのか詳しく見ていきます。 まずはサイトのトップページからユーザー登録を済ませておきましょう。メールアドレスを入力したらボタンをクリックしてください。 次にユーザー名とパスワードを設定すれば完了です！ 以下のようなダッシュボード画面が表示されます。 画面上部にあるボックスへWebサイトのURLを入
JSON にもコメントを書きたい - Qiita
JSON の構文は至ってシンプルです。 JSON は名前（キー）と値のペアがセットになった「オブジェクト」から構成されています。 キーはダブルクォートでくくられた文字列です。 値はダブルクォートでくくられた文字列、数値、真偽値、null 値、配列、またはオブジェクトです。 キーと値はコロン（ : ）で区切ります。 ペアとペアの間はカンマ（ , ）で区切ります。 前後を中括弧（ { , }）で挟みます。 { "文字列": "文字列", "数値": 0, "真偽値": true, "null値": null, "配列": [ "要素1", "要素2" ], "オブジェクト": { "キー": "値" } } そう、JSON にはコメントを記載するための構文がないのです。近年では設定ファイルなどで利用されることも多い JSON ですが、コメントによる説明が不要なキーを名付けることは現実的ではあり
リーダブルコード 5-6章 コメントについて · GitHub
readable-code-chap5-6.md 5章 コメントすべきことを知る コメントの目的は書き手の意図を読み手に知らせることである コメントすべきでないことを知る コードを書いているときの自分の考えを記録する 読み手の立場になって何が必要かを考える コメントすべきではないこと パっとみて当たり前にわかることをコメントに書かない // 休日を計算する function caliculateHoliday() { ... } // 関数実行時の年の1/1から12/31まで、祝日を除く休日を計算する function caliculateHoliday() {....} コメントにパッと見でわからないことを書くようにしよう 関数名がひどい場合はコメントではなく関数名を書く // Kintoneのカスタマイズでコメントを128kbに制限する // コメントにはコメント内容、コメント時刻、コ
Rubyコミッター・Yuguiに学ぶ、コードに書くべき「適切なコメント」と「適切な場所」 - エンジニアHub｜Webエンジニアのキャリアを考える！
Rubyコミッター・Yuguiに学ぶ、コードに書くべき「適切なコメント」と「適切な場所」 Rubyコミッター・園田裕貴（Yugui）さんが、長年の経験で体得したソースコードに書くべき「コメントの技法」を教えてくれました。 プログラミングにおいて、どんな初心者でも書けるけれど、適切に書くのは上級者でないと難しいもの。それがコメント（=ソースコードに書かれている注釈やメモ）です。 不適切なコメントをつけても、プログラムの動作には影響しません。しかし、書き方の巧拙によって、コードの可読性や理解のしやすさには雲泥の差が出ます。良質なコメントが良質なコードをつくるのです。 今回はRubyコミッターでありgrpc-gatewayの開発者でもあるSupership株式会社の園田裕貴（Yugui）さんに、優れたエンジニアがどんな観点を持ち、どんなコメントを書いているのかを聞きました。 園田 裕貴（そのだ・
なぜ我々はいまだに文字列でコメントを書いているのか - Qiita
あるいは、画像コメントのすすめ。 TL;DR 画像コメントのほうが意図が伝わりやすい 画像URLからツールチップで画像表示してくれるVSCode拡張機能があるよ その場で画像を作るSVGエディタもあったよ 問題提起 みなさんは、少し複雑なアルゴリズムを書くことになったときどうしていますか。 たいていの場合、いきなりコーティングに取り掛かるのでなく、 雰囲気をつかむためメモやホワイトボードに落書きすると思います。 特に幾何計算では簡単なものでも図を描いた方がいいです。こんな感じ。 図を書いたら後はコードに落とすだけです。 ね、簡単でしょう？ // 指定した直線を対称軸としたときの指定した点の鏡映位置を返す function flipVectorByLine(p: Vector, line: Line): Vector { // TODO: よくわかるコメントを書く const ln = ne
VS Codeで指定範囲をコメントにしたり戻したりするには
VS Codeで行コメントやブロックコメントを作成／解除するためのコマンドやキーボードショートカットを解説する。
ソースコードコメント – 引継ぎ者への警告 | 秋元@サイボウズラボ・プログラマー・ブログ
// Dear maintainer: // // When I wrote this code, only god and // I knew how it worked. // Now, only god knows it! // // Once you are done trying to 'optimize' this routine, // and have realized what a terrible mistake that was, // please increment the following counter as a warning // to the next guy: // // total_hours_wasted_here = 25 // 引き継いだ人へ: // // これを書いたとき、なぜこれが動くのか理解してるのは神と自分だけだった。 // そして今
コメントのいらないプログラムの書き方｜NZ MoyaSystem
パラメータを決める 次に関数に渡すパラメータを決めます。 関数の名前で表現されている処理を実現するには、どれだけのパラメータがあればよいか？ と考えてみましょう。 今回の例でいえば「お客さんの年齢」と「日付」があれば、すべてのチケット価格が計算できます。 ということで、age と date の2つのパラメータを渡すことにします。 function calculateTicketPrice (age, date) { } パラメータの名前も、なにを表しているかわかるようにしてくださいね。 くれぐれも「hensu」とか適当な名前をつけたり、同じ変数にぜんぜん違う値を繰り返し代入したりすることのないようにしましょう。 テストを書く 次にユニットテストを書きましょう。 テストは常に更新される仕様書です。 業務ロジックをテストに説明させておけば、関数の仕様をコメントにいちいち書く必要などありません。
テーブルにコメントを書く方法 - tanamonの稀に良く書く日記
コメントを含めてテーブルを作成する mysql> create table test( -> message varchar(200) comment 'カラムのコメント' -> ) -> engine=MyISAM -> default charset=utf8 -> comment='テーブルのコメント'; Query OK, 0 rows affected (10.91 sec) カラムのコメントは「comment '入れたいコメント'」という形式 テーブルのコメントは「comment='入れたいコメント'」という形式 書き方が微妙に違うので紛らわしい。 コメントの確認 mysql> select column_name, column_comment from information_schema.columns where table_name='test'; +--------
最近コード中のTODOコメントの書き方を工夫している - $shibayu36->blog;
コード中に後でやろうと思って以下の様なTODOコメントを書くことがあります。TODOコメントというのは # TODO: 後でリファクタリングしたい ... # TODO: 投稿機能ができたら置き換えること ... みたいなやつです。 コード中にTODOコメントを気軽に書いてしまいがちですが、よくTODOコメントが放置されて気づいたらプロジェクト中に大量のTODOコメントが書かれたりすることがあります。直せる量を超えてくると、直すモチベーションも下がってきて、結局ただのコメントと同じ状態になります。 最近いろいろ工夫して、TODOコメントの書き方を変えたところ、そこそこうまく回ったのでメモしておきます。 TODOコメントの問題点 問題点として次のものがあると考えました。 (1) 書く人によって形式がバラバラ TODO, XXX, FIXMEなどバラバラだったりする (2) TODOコメントの
プログラムにコメント書かない文化もあるよって話｜NZ MoyaSystem
以下の記事を読んで。 530000micro.hatenablog.com 僕が勤めている会社では、原則、プログラムにコメントを書かないのがルールです。 人生で初めてプログラムに触れてからこのかた、プログラムには必ずコメントを書けと指導されて来ましたし、自分自身も、後輩たちにちゃんとコメント書けよと言い聞かせてきました。そんなわけで、最初に全然コメントのないソースコードの山を見たときは、正直「ゲッ、なんじゃこりゃ……」と面食らったのは確かです。 ところが、「なぜうちのプログラムにはコメントがないのか？」と同僚に尋ねてみると、実に納得の行く回答が返ってきたのでした。 なぜコメントが必要なプログラムを書くのか？ 同僚いわく、「コメントが無くても読めるようなプログラムを書け」という思想が根底にあるのだそう。 適切に関数や変数が命名され、スコープがきちんと管理され、ロジックの流れが整理されているコ
コードは方法を語り、コメントは理由を語る | POSTD
私は コードにコメントを書く際の哲学について書いた投稿 の中で、 必要のないコメントこそが、最も優れたコメントだ と書きました。この点についてもう少し説明させてください。まず、コードはコメントに頼らなくても理解できるようにできるだけ簡潔にする必要があります。コードだけではどうしても分かりにくい箇所のみ、コメントを書き込むようにしましょう。 これを念頭に置いて作業することで、読者を常に意識しながら、コードが書けるようになります。1985年に出版された名著『 計算機プログラムの構造と解釈 』の、「第一版への前文」にも、この点について単刀直入に書かれています。 プログラムは人が読めるように、そしてコンピュータがついでに実行できるように書くべきである。 Donald E. Knuthも1984年に出版したエッセー『 文芸的プログラミング 』（ PDF ）の中で、同様のことを書いています。 これまで
JSONにはコメント行が付けられない？ネットで見つけた方法の有用性を試してみた | DevelopersIO
はじめに こんにちは植木和樹です。AWSではJSON形式を使う機会が結構多いですよね。ただJSONを使ってて不満なことが一つあります。それはコメント行をつけることができないことです。例えばJavaScriptのようにスラッシュでコメントを表現しようとしても構文エラーとなってしまいます。 { "key" : "value" // コメント } $ cat js_test.json | jq '.' parse error: Invalid numeric literal 特にCloudFormationのテンプレートや、IAMのポリシー設定は内容が複雑になりがちなのでコメントをつけておきたいと思うことが多々あり困っていました。 そんな時このようなブログを見つけました。「Adding Comments to JSON」。JSONでは同じキー文字列の要素が重複した場合に最後に定義したものが優先さ
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
プログラミングでコードが実行されないようにPythonだと#をつけてcomment outしますが、コメントアウトしたものをもとに戻すときなんといいますか？comment on？に対するYukihiro Matsumotoさんの回答 - Quora
パパパコメント
Sqlite: adding COMMENT ON descriptions to tables and columns?