Rubyコミッター・Yuguiに学ぶ、コードに書くべき「適切なコメント」と「適切な場所」 - エンジニアHub｜Webエンジニアのキャリアを考える！
Rubyコミッター・Yuguiに学ぶ、コードに書くべき「適切なコメント」と「適切な場所」 Rubyコミッター・園田裕貴（Yugui）さんが、長年の経験で体得したソースコードに書くべき「コメントの技法」を教えてくれました。 プログラミングにおいて、どんな初心者でも書けるけれど、適切に書くのは上級者でないと難しいもの。それがコメント（=ソースコードに書かれている注釈やメモ）です。 不適切なコメントをつけても、プログラムの動作には影響しません。しかし、書き方の巧拙によって、コードの可読性や理解のしやすさには雲泥の差が出ます。良質なコメントが良質なコードをつくるのです。 今回はRubyコミッターでありgrpc-gatewayの開発者でもあるSupership株式会社の園田裕貴（Yugui）さんに、優れたエンジニアがどんな観点を持ち、どんなコメントを書いているのかを聞きました。 園田 裕貴（そのだ・
ドメインモデルの構造設計 | システム設計日記
システム設計日記を検索 プロフィール masuda220 リンク システム開発日記(実装編) 有限会社 システム設計 twitter @masuda220 selected entries ドメインモデルの構造設計 (03/05) recent comment Smart UI が優れている？ ⇒ masuda220 (03/10) Smart UI が優れている？ ⇒ kagehiens (03/09) オブジェクト指向プログラミングの教え方？ ⇒ masuda220 (12/05) オブジェクト指向プログラミングの教え方？ ⇒ ZACKY (12/04) 「オブジェクトの設計力」 スキルアップ講座やります ⇒ masuda220 (08/14) 「オブジェクトの設計力」 スキルアップ講座やります ⇒ kompiro (08/14) 「オブジェクトの設計力」 スキルアップ講座やります ⇒
GitHub新機能「required review」の使い方 - Qiita
GitHubに新しく「required review」という機能が追加されました。この機能を利用すると、変更が承認されない限りはプルリクエストをマージできないようにする、といったプルリクエストの運用が可能になります。これまでのように、上がってきた差分にコメントを付けるだけでなく、修正を要求したり承認するフローがプルリクエストのレビュー機能として提供されているのが特徴です。masterブランチや、マージにフックしてCIでのビルドやデプロイが実行されるようなブランチに対しては厳格な運用が行えるため、部分的に取り入れるメリットは大きそうです。 GitHubから公式のリリースノートは発表されていますが、日本語での資料がなかったため翻訳してみました。原文に忠実であることよりも翻訳文の読みやすさを意識したため、意訳も多いですが、ぜひご一読ください。 ↓↓↓以下翻訳文↓↓↓ プルリクエストのレビューコメ
New attack bypasses HTTPS protection on Macs, Windows, and Linux
A key guarantee provided by HTTPS encryption is that the addresses of visited websites aren't visible to attackers who may be monitoring an end user's network traffic. Now, researchers have devised an attack that breaks this protection. The attack can be carried out by operators of just about any type of network, including public Wi-Fi networks, which arguably are the places where Web surfers need
イタリア人「カルボナーラの魔改造が酷すぎるから本当の作り方を教える」海外の反応 : 暇は無味無臭の劇薬
Comment by alekseevic19 イタリア料理を魔改造（raping）するのは止めろ。 カルボナーラ（Spaghetti alla Carbonara）の唯一のレシピはこれ。 「このスレではカルボナーラを作るために必要なことを教える。まず水を沸騰」 「次にグアンチャーレを用意。これベーコンじゃないから。豚肉の頬部分であって腹部分ではない」 グアンチャーレ (guanciale) とは豚の頬肉、いわゆる豚トロを塩漬けにして2、3週間熟成させたもの。表面に胡椒などのスパイスやハーブを刷り込んであるものが多い。 イタリアではローマ料理として有名なカルボナーラ（spaghetti alla carbonara）やアマトリチャーナ（pasta all'amatriciana）は、日本でよく用いられている燻煙されたベーコンではなくて、グアンチャーレを用いて作られる。 グアンチャーレ 「あ
コード内コメントとJavadocの書き方 - Kengo's blog
社内勉強会向けに作成したコード内コメントとJavadocの書き方についてのスライドを、Speaker DeckとSliDeckで公開しました。 このスライドは概要とメリットについてざっくり説明し理解と学習の動機を作ることを目的としていますが、これは日本ないし中国の大学ではコメントについてそこまで扱わないらしい*1という前提に基づいたものです。 ここに記載のない発展的な内容としては以下が挙げられますが、これらについて学ぶのはまず手を動かした後で良いと考えています。 API Specとは何か、何を書くことが望ましいのか（読み手目線に立った考え方） package-info.java によるパッケージに対するドキュメンテーションコメント Mavenでjavadocを出荷する方法 ＠Documentedアノテーションとは何で、いつ必要なのか コード内コメント以外のドキュメント（README、コミッ
テスト分析入門 -「ゆもつよメソッド」を例に- #wacate
2. + 参考文献 ソフトウェア・テストPRESS 総集編 ソフトウェア・テストPRESS Vol.10 特集1：今こそ聞きたいテストの上流設計 Vol.10自体の販売はすでに終了 総集編のPDF収録版は入手可能 http://www.amazon.co.jp/exec/obidos/ASIN/4774147338/wacate-22/ref=nosim/ JIS X 25010：システム及びソフトウェアの品質モデル http://kikakurui.com/x25/X25010-2013-01.html マインドマップから始めるソフトウェアテスト http://www.amazon.co.jp/exec/obidos/ASIN/4774131318/wacate-22/ref=nosim/ 2014/06/21WACATE 2014 Summer
Facebook Relayについてまとめ - Qiita
Reactがもっと広まって欲しいと思っている今日このごろ。React EuropeでJoseph Savona氏の講演でRelayについての「モヤっと」がいっきにかなり解消された気がするので、要点を本編を翻訳しながら自分なりにまとめておきます。 私の理解が誤っている可能性は十二分にありえるので、ご指摘いただければ幸いです。 はじめに ReactとFluxって組み合わせと共によく目にするのが↓の図。 矢印は一方向にしか進まないのが特徴で、わかりやすいってのがいろんなところで書かれているんですけど、 結局データをサーバからとってくるところってどうなってるの？ってのが疑問として残ります。つまり、図で表現すると↓の部分の仕組みがどうなっているかってところです。 その部分を、Instagramのようなサービスを例に説明しています。 クライアントはどのようにしてサーバからデータを取得すべきか まず、I
IntelliJ IDEAが便利になる40のショートカット - 壷ラボ
ここ数カ月、家でも仕事でもIntelliJ IDEAを使っているのですが、せっかくのIDEなのにショートカットをほとんど使っていなくて宝の持ち腐れ状態になっているので、ちょっと調べて便利そうな物を一欄にまとめてみました。 Macでは微妙に違うものもあるので注意。 ショートカット 動作 Ctrl + Space Basic Code Completion Alt + Enter Show intention actions and quick-fixes Ctrl + Alt + L Reformat code Ctrl + Alt + O Optimize imports Ctrl + P Parameter info Ctrl + Q Quick Documentation lookup Ctrl + F1 Show descriptions of error or warning at
valid-jsdoc - ESLint - Pluggable JavaScript Linter
JSDoc generates application programming interface (API) documentation from specially-formatted comments in JavaScript code. For example, this is a JSDoc comment for a function: /** * Add two numbers. * @param {number} num1 The first number. * @param {number} num2 The second number. * @returns {number} The sum of the two numbers. */ function add(num1, num2) { return num1 + num2; } If comments are i
TypeScript の開発環境構築と周辺ツールの紹介
前回はなぜTypeScriptか？という話を書きました。今回はTypeScriptを使うとして、どういう環境を作れば気持ちよく開発できるかについて解説します。 本稿に出てくるサンプルをまとめたリポジトリを随時メンテしております。時期によっては、本記事の内容に沿わない（より磨かれた）状態になっているかもしれません。 TypeScriptの開発環境が指すものは2つあります。IDEやエディタといった、本当に開発を行うための環境と、初期設定を行ったりリリースビルドを作ったりするためのタスクランナーの二種類です。 本記事ではお勧めの構成として、Visual Studio Code+grunt+dtsmを用いていきます。別構成として、Atomとgulp、tsdについても言及します。いずれの構成でも、Mac OS X、Windows、Linuxといった主要なプラットフォームで同じように動かすことができま
モリスNight - hotchemi-ja-blog
追記 この記事を鵜呑みにしてヤバい事にならないように。 というか今更調べてみたけど、メールにある会社名で調べても有料人材紹介事業の許可取ってないじゃん、アウトじゃんトニーモリス pic.twitter.com/6qI8onMd0o— yuki fujisaki / tnj (@tnj) August 29, 2015 この業界で働いてるはずなのにLinkedInもFacebookも存在しないモリスは非実在の架空人物である可能性が高く、どこからか仕入れた個人情報を使って活動している人たちの覆面な感じがしてる。まったく同じ文面で他の名前で来たりするし、彼らもソーシャルアカウントは見つからない。— yuki fujisaki / tnj (@tnj) August 29, 2015 tl;dr トニー・モリスに会いに行ったけど全然違うアメリカ人リクルーターと談笑して終わった トニーモリス何事かと
ギタフリ用コントローラ + GamepadAPIでアーメンブレイク - マルシテイア
起床即アーメンブレイクした ギタフリ用コントローラ持っててPCにつなげる人はここで試せます http://gmork.in/guitarbreaks/ 解説 GamepadAPI というのがある http://www.w3.org/TR/gamepad/ これは GamepadAPI と Web Audio API 組み合わせて音鳴らしてるだけ。 クオンタイズ頑張ればもっとキレイに鳴らせるかなー 経緯 先日のWeb Music ハッカソンにギタフリ用コントローラで発表してる人がいて、GamepadAPI の紹介してた。 （名前わすれてしまった…） 実は僕も以前同じ事をやろうと思ってギタフリ用コントローラ買ってたのだった。 Processingとかで試してたんだけど、Mac で上手く認識されなくて諦めた。 今回リベンジするにあたって、「もしかしたらコンバータが悪かったのかな？」と思いPS用コ
Quip
Introducing QuipQuip helps sales teams accelerate business in real-time. Reimagine sales processes with embedded documents, live Salesforce data, and built-in collaboration. Learn More What is Quip?Quip is the easiest way for Salesforce customers to transform processes like Account Planning, Mutual Close Plans, and Qualification Notes. Standardize, automate, and embed real-time, collaborative docu
提言: コミットメッセージの一行目には要求仕様を書け - Qiita
これは Git (や Subversion などのバージョン管理システム) にコミットする時により良いコミットメッセージを書くための提言です。この提言は特にメッセージの一行目だけを対象とします。せめて最も重要な一行目だけでも良いメッセージを書いて欲しいからです。提言をズバリ一言で表すと 一行目には要求仕様を書け です。 背景 プロジェクトによっていろいろ慣習の差はあるものの、一般的には「コミットメッセージの一行目は変更内容の要約を簡潔に書け」とされます。特に Git は、各コミットメッセージの一行目だけを取り出してそれを一覧表示するなど、一行目を特別に処理する機能が多いので、一行目にできるだけ多くの情報を凝縮させることは重要です。またメッセージを一行しか書かない不届きな慣習のプロジェクトでは、十分な情報を持たないメッセージは無用の長物と化します。 良くないコミットメッセージ しかし私は、情
ネイティブと働いて分かった英語コミットメッセージの頻出動詞10つ
ウッ ここで詰まる事は往々にしてあります. 特に急いでる時の煩わしさは甚だしいです. どうせならそれっぽい英語を使いたいのでOSSや同僚のコミットメージの語彙の出現確率を調べてみましたら、 もちろんfeatureによってコミットメッセージの付け方など数多あるものの、一定の頻出パターンは見い出せたので筆を取りました. （英語勉強しないと..） 方法 github.com/rails/railsのコミットメッセージ内における各動詞の出現確率を求め、 またOSSと仕事でのコミットメッセージの趣向も変わってくる事も勘案するため、 （仕事でDeprecateとか滅多に使わんし） 同僚に聞きつつ10つあげてみた. 以下列挙 （例は実際の同僚やOSS上でのコミットメッセージです.） Add *A to *B AをBに加える
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
イマドキのExcelスクショの撮り方
GitHub - eslint/doctrine: JSDoc parser