JSON にもコメントを書きたい - Qiita
JSON の構文は至ってシンプルです。 JSON は名前（キー）と値のペアがセットになった「オブジェクト」から構成されています。 キーはダブルクォートでくくられた文字列です。 値はダブルクォートでくくられた文字列、数値、真偽値、null 値、配列、またはオブジェクトです。 キーと値はコロン（ : ）で区切ります。 ペアとペアの間はカンマ（ , ）で区切ります。 前後を中括弧（ { , }）で挟みます。 { "文字列": "文字列", "数値": 0, "真偽値": true, "null値": null, "配列": [ "要素1", "要素2" ], "オブジェクト": { "キー": "値" } } そう、JSON にはコメントを記載するための構文がないのです。近年では設定ファイルなどで利用されることも多い JSON ですが、コメントによる説明が不要なキーを名付けることは現実的ではあり
コメントの書き方[PowerShell] : バヤシタ
PowerShell では 1 行だけコメントアウトする方法と、複数行をまとめてコメントアウトする方法の 2 つがあります。 1行だけコメントアウトする場合複数行をまとめてコメントアウトする場合 1行だけコメントアウトする場合 PowerShellでは # で始まる行はコメントとして扱われます。サンプルコードは以下の通りです。
Multi-line strings in JavaScript and Node.js
When writing Node.js or JavaScript applications, you sometimes need to embed multi-line strings in your code. It may be a snippet of HTML, a fragment of textual template, a piece of XML (remember XML?), or code in another programming language. JavaScript has no built-in way of representing multi-line strings. If you need to embed a longer non-JavaScript text in your application the natural options
migration_comments + annotate で MySQL のカラムコメントを管理する - kakakakakku blog
今まで MySQL のカラムにコメントを付ける習慣がなかったんだけど，いざ新メンバーとして既存コードを読んで理解する立場になってみると，ちゃんと書かれたコメントのおかげでスキーマを理解しやすかったし，メンバー間の認識相違も生まれないし，重要だなと実感している． 確かに「コメントを付けないと理解できないならきっとテーブル設計やカラム設計に欠陥があるのでは？」という意見もあると思うし，それは否定しないけど，キレイに設計したとしても，ドメイン依存したコードやマジックナンバーもあるわけで，コメントを付けることが大きなメリットを生む場面は絶対にある． Rails で試してみる 今はもう Rails を使ってないんだけど，Rails で MySQL のカラムにコメントって付けられるの？と思って調べてみたら，基本機能ではできなさそうだった． migration_comments Gem を使う migr
Visual Studioの選択行コメントアウトのショートカットキー - amberfrog.log
ぼくの場合、Visual Studioでいちばんよく使うショートカットキーは、編集系ショートカット御三家であるところの Ctrl+C (コピー)Ctrl+V (ペースト)Ctrl+X (カット)とオマケの Ctrl+Z (アンドゥ)をのぞくと、選択行のコメントアウト、コメントアウト解除ができる Ctrl+E, C (コメントアウト)Ctrl+E, U (コメントアウト解除)だったりします。 くっそマジメに解説すると、Ctrlキー押下しながらEキーを押して、Ctrlキーを離してCキーを押下する、という操作ですな。 コレ、C#でもXAMLでも、エディタに応じて適切なコメントアウト/コメントアウト解除ができるのでかなりの頻度で使うワケですよ。Eclipseとかの場合はCtrl+/でしたかね。ちょっと覚えてません。 さておいて、仕事ではいまだにVisual Studio 2010をバリバリと叩きま
変更前をコメントアウトして残す習慣は未だ根強い (2012年現在) - 日々常々
2020-03-11追記: タイトルの「未だ」がいつなのかわかりづらいので「2012年現在」を追加しました。 バカバカしい話ですが、ソースコードをSubversionなどでバージョン管理しているにもかかわらず、未だ修正前をコメントアウトして残す習慣は残っているところも多々あります。こういうのです。 // 2012/08/15 irof 修正開始 // hoge = fuga(1); hoge = fuga(2); // 2012/08/15 irof 修正終了 見た事無い方は、そのまま見ないままで生きていかれることを切に願います。 コメントの修正がある場合 2012/07/21にあった、SCMBCでこんなツイートがありまして。 この時点でお見せしたのはこんな感じ。 // 2012/07/21 削除開始 // // 間違ったコメント // 2012/07/21 削除終了 someMethod
名状し難いコードを書く(コメント編) | Webシステム開発／教育ソリューションのタイムインターメディア
あらすじ 長年プログラムを書いていても、良いコメントを書く技術ってぇのはなかなか身に付かないもので、 良かれと思って書いたコメントでも後々読み返すと書いた当人ですら首を傾げる始末。 長屋に住む八五郎もそんなSEの一人。 ある日、出社すると親方エンジニアがカンカンに怒っている。 どうやら先週末の退社前にレビューしてもらおうと push したコードについてらしい。 特に不味いところはなかったはずだが、はて、何が悪かったのだろうかと親方のデスクのモニターを覗き込むと── さっぱり役に立たない <summary> 八五郎は普段から Visual Studio で C# のコードを書いている。 こいつにはXML Documentation Commentsというのがあり、 一定の書式に従って型やメンバーにコメントを書いておけば、 インテリセンスで有意義なメッセージが表示されたりAPI リファレンスの
技術者の評価を下げる「悪い」コメントに注意しよう
ソフトウェアの受託開発や、オープンソースのプロジェクトでは、ソースコードが他の技術者の目に触れる。そのため、ソースコードから開発者の技術力が評価されやすい。 ソフトウェアの開発者は、モジュール分割やクラス設計には全力を傾ける。最近では、設計の完成度を高めるために、実装の後でリファクタリングを行うことも珍しくない。 だが、設計の善し悪しにこだわる開発者でも、ソースコードに書くコメントの品質までは、配慮が及ばないことが多い。コメントは本質的なものではないので、つい気を緩めてしまうのである。 ところが、開発者の希望に反して、ソースコードの読み手が印象を受けやすいのは、コメントの品質である。ソースコードから設計を読み解くのは容易ではないが、日本語や英語で書かれているコメントは目に付きやすい。 優秀な技術者の書いたソースコードでも、驚くほど「悪い」コメントが書かれていることがある。そのようなソースコ
ソースコードで発見した奇妙なコメント集
2013年3月23日 ネタ コーダー・デベロッパー・プログラマーさん達はそのソースコードにわかりやすい説明書きを「コメント」として残し、後から他の人が修正・編集しやすいようにコードを書いていきます。Stackoverflowの中でなんだそりゃー！というコメントがまとめられていたのでいくつか翻訳してみます！「クライアントからのムチャぶり迷言集 」に続き久しぶりにネタ系記事です。楽しんでください！ ↑私が10年以上利用している会計ソフト！ プログラマーさん達の名誉のため、先に言っておきますが、全てのプログラマーがこういったコメントを残しているわけではありませんよ！「こんなの書く人いるんだー世の中いろんな人がいるもんだー」くらいに軽く読んでみてください！ 自信を失したプログラマー達 自虐コメント多数！ // ごめん。 /* お願い…動いてくれ… */ // このコードは最低だ。知ってるだろ？俺も
達人プログラマーに学ぶ コメントは必要？不要？ | Act as Professional
HIROCASTERの経験から SIer時代にコメントの重要性と言うより納品物としての必然性を教え込まれた記憶がある。例えば、こんなコメントは不必要である。 class foobar { /** * foobar class のコンストラクタ */ public function __construct() { foo = array(); bar = array(); } } 「public function __construct()」と書かれているのにわざわざ上でコメントを書く必要性はない。同じ意味を違う言語(表現)で書いているだけだ。重複であるといってもよい。DRYの考えに反する。 でもこれ、ドキュメントを自動生成して納品物とする場合、クラスずつにページがあって、コンストラクタの場所にいろいろと書かれている場合と何も書かれてない場合とかってのは、納品物として白紙はまずいわけで、こう
詳細設計書のネガティブな側面 - wwolf.web.fc2.com
文書情報 更新履歴 2010.01.10 -- 新規作成 2011.04.29 -- 最終更新 本稿の目的 システム開発において詳細設計書というドキュメントが要求されることがある。多くの場合、労力の無駄になり、保守時にも酷い足枷になる代物であるが、この業界では未だに健在である。 本稿ではそのような詳細設計書をアンチパターンと定義し、その背景と問題を追い、解決策について議論する。 「詳細設計書」とは何か 実装についてステップ単位で記述された重厚長大な技術文書 本稿で扱う「詳細設計書」とは、まるでソースコードを日本語に訳したかのようなソースコードの一行と一対一で対応したプログラムの設計書を指す。またの名を「プログラム設計書」とも言う。 どのようなプロジェクトで作られるのか 大手SI企業が関わるプロジェクトで多く見られる現象である。 詳細設計書を記述する動機 設計情報の属人化防止 詳細設計書を記
技術レポート「効果的なソースコードのコメントについて」｜ソフテックだより｜株式会社ソフテック
コメントとは、プログラム言語で書かれたソースコードのうち、覚え書きとして記述される注釈のことです。 コメントは多ければ良いというものではなく、意味のないコメントはコーディング時間の無駄になるばかりか、ソースコードを読む人を混乱させることにもなります。 そこで本号では、効果的なソースコードのコメントの書き方や注意点について紹介したいと思います。プログラム言語はC言語で説明します。
『エンジニアのためのJavadoc再入門講座 現場で使えるAPI仕様書の作り方』 - 暫停使用
9 冊目の著作となる本書は、ある意味私らしい「ややズレた」スタイルの書籍となりました。6/29 発売ですが、池袋ジュンク堂では本日先行入荷したそうです。 ちなみに、サブタイトルは「現場で使える API 仕様書の作り方」。Javadoc をテーマとした書籍は、恐らく世界初ではないかと。 エンジニアのためのJavadoc再入門講座 現場で使えるAPI仕様書の作り方 作者: 佐藤竜一出版社/メーカー: 翔泳社発売日: 2009/06/30メディア: 単行本（ソフトカバー）購入: 15人 クリック: 263回この商品を含むブログ (49件) を見る 本書は、意味のある Javadoc(ドキュメンテーションコメント)をほとんど見たことがないという現実を何とかしようと思って書きました。確かに、多くの Java のソースコードにはドキュメンテーションコメントが記述されています。しかし、その多くは「メソッ
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
TODO: 以外のアノテーションコメントをまとめた - Qiita
コメント書うんたの詳細情報 : Vector ソフトを探す！
Loading...
Welcome to nginx!
Lisp:コメント