良いコードの書き方 - Qiita
概要 チームによる継続的開発を前提としたコーディングのガイドライン。 特定の言語を対象としたものではないが、主に静的型付けのオブジェクト指向言語を想定している。 サンプルコードは別段の定めがなければSwiftで記載。 ガイドラインの目的 生産性を高め、メンテナンスコストを下げる バグが生まれづらくする 開発メンバー（特に新規参加者）がコードを理解しやすくする 初心者プログラマーの教育 内容の説明 タイトルの頭についた【数字】は重要度。 高いほどシステムに与える影響が大きいが、低いものの方が影響が小さく改修しやすいものが多い。 【5】変数のスコープを小さくする 変わり得る値は複雑さを生み誤解やバグに繋がるため、プログラムは変数が少ないほど問題が生まれづらい。 プログラミングの大原則として、変数は必要最低限を心がけ、むやみに増やさないようにする。 また、変数はスコープや寿命が大きいほど悪影響が
コードの可読性についてのプレゼンテーション紹介 vol. 1: "導入と原則" 編
はじめに こんにちは。コミュニケーションアプリ「LINE」の Android クライアントチームの石川です。 先日、コードの可読性についてのプレゼンテーション (https://speakerdeck.com/munetoshi/code-readability) を公開しました。 今後、このプレゼンテーションについてのちょっとした解説を、本ブログ上で不定期に連載していきます。 今回は、このプレゼンテーションの概要と、最初の章 "導入と原則" についての解説を行います。 このプレゼンテーションについて このプレゼンテーションは、コードの可読性を向上するためのアイディアをまとめたもので、以下の8つの章からなります。 導入と原則: 可読性の高いコードの重要性、プログラミング原則 命名: 名前の示す内容、文法、語の選択 コメント: ドキュメンテーション、インラインコメント 状態: 状態遷移の管理
Gitリポジトリ上のソースコードをWebブラウザから検索・分析できるコード検索ツール「Sourcegraph」 | さくらのナレッジ
大規模なソースコードを分析・閲覧する際に有用なのが、ソースコード専用の検索ツールだ。こういったツールは複数あるが、今回はGitリポジトリやGitHubなどのホスティングサービスとの連係機能を特徴とするオープンソースの検索ツール「Sourcegraph」を紹介する。 Webブラウザ上からGUIで操作できるソースコード検索ツール システム開発の現場において、クラスや関数がどこでどのように定義されているのかを調べたり、メッセージなどで表示される特定の文字列がどこで使われているかを調べたりするといった作業は割と頻繁に発生する。こういった作業はgrepなどの汎用検索ツールでも可能ではあるが、その場合たとえばソースコード以外のファイルに含まれる文字列も検索に引っかかるほか、その出力もやや見にくい。そこで活用したいのが、専用のソースコード検索ツールだ。 ソースコード検索ツールでは、対象のソースコードがど
ソースコードはしゃべるように書け - Qiita
はじめに この記事は、僕が配属当初に先輩からよく言われた「ソースコードはしゃべるように書け」について、それが具体的に何を意味するのかを、配属から6年経った今改めて考えてみる記事です。 その先輩はすでに辞め新しいステップへ進まれてしまったためにその真意を直接聞き直して確認することはできないのですが、今の僕なりの解釈、ということで書いてみます。 とは言え、「ソースコードはしゃべるように書け」は「ソースコードの読みやすさ」という意味では役に立つ考え方ですが、それがどんな場面でも正しいかというとそうではないと思っています。おそらく、自然言語に近づけた書き方よりも、より機械の仕組みに近づけた書き方をした方がはるかに効率がよかったり、安全な言語や場面もあると思います。 また、仕様自体が複雑だったり、既存のソースがすでに汚いなどの理由で、この記事に書いたようなことがすんなり実行できる環境というもの自体が
ソースコードを分析し、コードの構造や階層・依存関係を可視化する便利な無料ツール -Code Crumbs
フローチャート ※依存関係・フローチャートはJavaScriptのみです。 対応言語は、下記の通り。 JavaScript TypeScript Python PHP Java C++ 望む言語が他にあればIssueにどうぞ、とのことです。 Code Crumbsのデモ デモでは、JavaScriptのコードでその動作を確認できます。 デモページ 依存関係はDependenciesをオンに、フローチャートはFlowChartタブをクリックします。 Code Crumbsの使い方 セットアップ codecrumbをインストールします（yarn global add codecrumbs）。 codecrumbs -d project-src-dir -e project-src-dir/index.jsを実行し、プロジェクトに合わせてパラメータを変更します。-dはソースコードを含むディレクト
個人的にコードリーディングがはかどったテクニックまとめ - Qiita
はじめに コードリーディングの重要性はそこらじゅうで語り尽くされてる感があります。 僕も地道にコードリーディングをしているのですが、いざやろうとするとハードルが高いことがままあります。そこで、個人的にコードリーディングがはかどったと感じたテクニックをまとめておこうと思います。 筆者環境の前提 ソースコードのバージョン管理は Git を使っている 開発 PC は Mac を使っている エディタは Vim を使っている ghq + peco で読みたいリポジトリに気軽にたどり着く 読みたいソースコードのリポジトリが増えてくると、ローカル環境でのリポジトリをどのディレクトリに置くか、またいざ読もうとするときにディレクトリを辿っていくのが煩雑になってきます。 そんな時、読みたいリポジトリに気軽にたどり着くことができれば、読むハードルが下がります。 僕は peco と ghq の組み合わせを使ってい
40点でもいいから、まず公開する。マンガでわかる技術書「わかばちゃんと学ぶ」シリーズが生まれるまで
2018.02.02 40点でもいいから、まず公開する。マンガでわかる技術書「わかばちゃんと学ぶ」シリーズが生まれるまで Webサイト製作の基本を、漫画で初心者向けにわかりやすく解説する「わかばちゃんと学ぶWebサイト制作の基本」や、漫画と実践で学ぶGit（※）の入門書「わかばちゃんと学ぶ Git使い方入門」。 これらの著者である湊川あいさんは、フリーランスのWebデザイナーであり、漫画家でもあり、さらに技術書の執筆者でもある異色のキャリアの持ち主です。 かつては、社員としてWebデザイナーの仕事だけをしていた湊川さん。果たして、彼女はなぜ漫画でITを解説しようと考えたのでしょうか？ ※Git…プログラムのソースコードなどの変更・追跡するためのバージョン管理ツール。 Webの世界へ足を踏み入れたきっかけは「素材屋さん」 ――湊川さんはWebデザイナーとして自身のキャリアをスタートしたそうで
ソースコードって実際のところどういうふうに書いていますか？｜Rui Ueyama
私はプログラミングは結構自信があるんですが、他の人の作業をつぶさに観察したことがあるわけでもないので、自分で当たり前だと思っているコーディングの方法が他の人にとってはそうではないこともあると思ってます。上手い人がどういうふうにしてプログラムを書いているのか知りたいんですよね。 逆に私はどういうふうに書いているかちょっとまとめてみました。自分はこうしている、というのがあったらぜひ教えてください。 まず私の場合、ゼロからコードを書くよりも現在のプロジェクトのためのコードを書くことのほうが多いので、コードを書くというのは既存のコードに変更を加えることがほとんどです。既存のコードに手を加えるときは、新機能追加か、リファクタリング（動作は変えずにコードをきれいにすること）のどちらかになるわけですが、まず前者をどうしているかどうかをできるだけ説明してみます。 まず必要なのは考えることです。よく知ってい
私のソースコードの書き方 - @kyanny's blog
note.mu なるほど自分も同じような感じでやっているなぁ、と思った。もうちょっと詳しく書くと、 まず変更しようと思っている部分の周辺のコードを読んで、「ここらへんをいじればよさそう」と当たりをつける（当たりのつけかたにもいろいろあるのだが後述） 土地勘を養ったところで具体的な変更の仕方を考える。必要に応じて紙に下手くそな図を書いたり、考えを箇条書きにしたり、実際にコードを試しに変更してみたりする この方針でいけそう、と道筋が見えたらいよいよコードを書き始める。細かい単位でコミットするかどうかは場合によるが、少なくとも git add はこまめに行う（エディタの undo でせっかく書いたコードを失わないため） 道筋が見えなかったり、プロトタイプ的に書いたコードが望み薄そうだったら潔く諦める。煮詰まっていることを自覚して、コーヒーを買いにいったり、オフィスの外を散歩したりして頭をリフレッ
超高速grep「The Silver Searcher(ag)」からhighwayに乗り換えた - SHOYAN BLOG
プログラマーにとって，grepコマンドはなくてはならない存在です。 基本的かつ古典的なユーティリティであるgrepですが，使いにくい面もあります。 2013年のはじめころから，grepに取って代わるコマンドとして「The Silver Searcher」（以下「ag」）が注目されはじめました。 そして最近、highwayというagライクで高速なgrepツールがリリースされました。 The Silver Searcher（ag）とは？ highwayの紹介の前にagとagが開発された背景について説明したいと思います。 プログラムを書いていると，ソースコード全域にわたって文字列を検索したい，ということはよくあります。 そのようなときにgrepコマンドが活躍するわけですが，ソースコードのディレクトリには検索したくないファイルが往々としてあるわけです。 たとえばバージョン管理システムが使っている「
ソースコード探険隊
What's new - 更新履歴 直近20件の新しい記事です。 2024-07-28: Lenovo IdeaPad と ThinkBook の違い・比較 2024-02-28: ASUS ROG ノートパソコン FLOW・ZEPHYRUS・STRIX の違い、比較 2024-01-14: ASUS ノートパソコン製品シリーズの違い・比較 2023-12-10: ゲーム開発に最適なノートパソコンの選び方／おすすめ機種紹介 2023-11-18: 動画編集に最適なノートパソコンの選び方／おすすめ機種紹介 2023-11-03: プログラミングに最適なノートパソコンの選び方／おすすめ機種紹介 2023-09-09: 『ノートパソコン購入ガイド』を公開 2023-04-29: 推理小説『水車館の殺人』の感想 2023-03-26: Lenovo 公式サイトの「ThinkBookとThinkPa
コード リーディング
コード リーディング(code reading)とはソースコードを読むことです。コード リーディングについてもう少し詳しく知りたい人は「 コード リーディングについて 」をご覧ください。 本書では筆者が「あのアプリケーションのあの機能はどうやって実現されているのか?」と思ってソースコードを読んで発見したことや奮闘の記録を掲載しています。題材とするソフトウェアはオープンソースで開発されているもので筆者の好奇心によるものです。 文書はプログラミング言語別に分類しています。
サービス終了のお知らせ - NAVER まとめ
サービス終了のお知らせ NAVERまとめは2020年9月30日をもちましてサービス終了いたしました。 約11年間、NAVERまとめをご利用・ご愛顧いただき誠にありがとうございました。
Photoshop 1.0のソースコードが公開・無料ダウンロード可能に
Adobe Photoshop 1.0のソースコードがComputer History Museumで公開・無料でダウンロードすることが可能になりました。Photoshopは1987年に当時大学生であったトーマス・ノールさんが開発、AppleとAdobeに見せたところAdobeがライセンスを取得し、1990年にバージョン1.0が発売されました。現在から20年以上前に作られたソフトなのですが、そのバージョン1.0.1に使われた12万8000行に及ぶ179個のファイルを見ることができるようになっています。 Computer History Museum | @CHM : Adobe Photoshop Source Code https://computerhistory.org/blog/adobe-photoshop-source-code/ こちらが開発を行ったトーマス・ノールさん。Ph
人様の git リポジトリを milkode で簡単に管理するインタフェース「gitomb」を作った - tomykaira makes love with codes
tomykaira/gitomb Milkode は数万のファイルでも軽々動く、ソースコード検索エンジンです(製作者は id:tuto0621 さんです）。 しかし、数万ファイルもあるリポジトリなんて管理しますか?普通。 ソースコードを検索する回数がもっとも多いのは、既存のライブラリの使い方がよくわからないときに、ドキュメントに乗っているメソッド名を手掛かりに検索して、望みの機能を発掘していくような時のはずです。いままで、ライブラリのコード検索をしようとおもったら、 ライブラリを落としてくる そのディレクトリに移動する git grep かなんか ヒットしたファイルをエディタで開いて、まわりを見回す 見付かるまで検索をくりかえす みたいなことをやっていました。milkode web を使うと、次のようになります。 ライブラリを落としてくる そのディレクトリに移動する milkode
空き時間にスマフォでソースコードが読める『CodeLibrary』をリリースしました！ - hamheiの日記
英語でこの記事を読む（Reading in English） ・4/5 追記: 好きなプロジェクトのコードが読めるPocketCodeをリリースしました。 クリスマスも当然の如く開発充なはむへいです！ 僕と同じくクリエイティブで孤独なＸデイを過ごす500万人のエンジニアを応援する為に 『CodeLibrary』というOSS（オープンソースソフトウェア）のコードをスマフォ上で読めるアンドロイドアプリをリリースしました！ きっかけ 「OSSも読まないエンジニアって...」という記事を読んで、慌ててコードリーディングを始める 移動中にSNSを見る時間を、コードリーディングに充てたい スマフォでソーシャルにコードリーディングが出来るプラットフォームを作ろう！ ベータ版ができたから公開するお^^ ←ｲﾏｺｺ どんなアプリ？ ちょっとした空き時間に、スマートフォン上でソースコードが読める、アンドロイド
netail.net
自作フリーソフトや，ゲームに関する雑記を公開してます． 日記はソフトウェア工学の論文ネタが中心です． _ [ツール] CCFinderX on Windows 64ビット版 ▲ CCFinderX の実行に必要なのは次のソフトウェアです． JDK 6 32ビット版 Python 2.6 32ビット版 前の記事にも書いてますが，Python は2.6でなければなりません（2.7以降だとクラッシュします）．また，使っているDLLのバージョンが32ビットなので，64ビットバイナリではDLLが読み込めず，起動できません．64ビット版のWindowsを使っている場合でも，必ず32ビット版のJDK，Pythonを使ってください． これらがインストールできたら，CCFinderX の GUI フロントエンドを起動するgemx.batを修正します． set CCFINDERX_PYTHON_INTERPR
ccccを使って、C/C++のメトリクス集計を行い、CSV化する - ふにゃるんv2
前回のCCFinderのネタからこっち、id:Seasons さんから頂いたコメントを読み返しつつ、プログラムの「評価基準」って何だろね？と時折ぐーぐるしてました。 …そ〜いえば、オープンソース系で評価ツールって、何かあったっけなぁ？と思いつつ、適当に ぐーぐるしていたんですが、この手のソフトは Javaが圧倒的にヒットしますねぇ。まぁ、.NET系に比べて年数も違うし、マクロやテンプレートなんていう一歩間違えるとダークサイドなものもありませんからね。 そんな中、ccccっていう冗談みたいなソフトを見つけました。 SourceForge.net: C and C++ Code Counter http://sourceforge.net/projects/cccc UNIXの部屋 検索:cccc (*BSD/Linux/Solaris) http://x68000.q-e-d.net/~68
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
ソースコード検索エンジン「Sourcetrail」OSS化、GitHub上で公開
ソースコードの品質向上のための効果的で効率的なコードレビュー
