大手ITスタイルガイドがベースGoogleやMicrosoftなど大手IT企業の英語スタイルガイドの基準がベース。一般的な英語表記から外れません。
タグ検索の該当結果が少ないため、タイトル検索結果を表示しています。
目次 なぜSQLのスタイルガイドが重要なのか この記事の目的 この記事の対象者 分析SQLスタイルガイドの指針 基本ルール 命名規則 インデントルール 別名ルール joinルール クエリ分割ルール ⭐ コメント欄で「いや私はこう思う!」という意見をたくさんいただきました!ぜひそちらも御覧ください!(決して揶揄ではないです) なぜSQLのスタイルガイドが重要なのか SQLはプログラミング未経験者でもとっつきやすい言語と言われ、エンジニアや分析を本業としていない人でもSQLを使う機会が増えてきていると思います。 そんなSQLですが、こちらのブログでも指摘されている通り、一般的なスタイルガイドが定まっていません。スタイルガイドとはコードの書き方マナーようなもので、どこで改行するか、空白はいくつ入れるか、大文字を使うかなどの諸々を指します。 もしスタイルガイドが無いとこんな事が起こります コードに
3/30 に X で Terraform がトレンド入りしていて何事かと思ったら Terraform が公式ドキュメントとしてスタイルガイドを出したようです。 Terraform Style Guide いままで Terraform のスタイルに関して信頼できるドキュメントといえば Google Cloud の Terraform を使用するためのベスト プラクティス ぐらいしか知らなかったのですが、 Terraform 公式がようやく出してくれてありがたい限りです。 これでわざわざ社内の Terraform 規約を設けずとも「公式ドキュメントに従いましょう。」の一言で済みます。 ということで一通り読んだのでまとめました。 原文だと構文の簡単な使い方なども書いてありますが以下の要約ではだいたい省略しています。 詳細は原文を読んで確認してください。 要約 スタイルガイドについて コードのスタ
TypeScript の型レベルプログラミングのための真面目なスタイルガイドではありません. 型なしラムダ計算で喜ぶような人間が使うための諸刃の剣です. この記事の内容は TypeScript の 2022 年 1 月時点での最新版である 4.5.4 に基づいています. 将来のバージョンでの妥当性は保証しません. 「型〜」「〜型」という用語の「型」はしばしば省略します. 値レベルの話題は一切登場しません. 以前作った型レベル Brainfuck インタプリタはこのスタイルに則っているので参考にどうぞ. いつまでこのネタを引きずるんですか? パラメータに対して制約を付与しない 型定義のパラメータに対して extends を使って制約を付与すると, そのパラメータに与えられる引数を制約を満たすもののみに限定することができます. 例として, 以下の Append には string の部分型のみ
スタイルガイド PEP-8 Google Python Style Guide django 既存のコードに対するpep8の確認 pep8 flake8 autopep8 docstringのフォーマット 各スタイルガイド要約 PEP8 Google C++ 参考文献 自分の確認用です. C++のスタイルガイド の確認も自分の勉強用です. スタイルガイド スタイルガイドは、出版物などにおいて統一した言葉遣いを規定する手引き (出典:スタイルガイド - Wikipedia) コーディングにおいても, 基本的な書き方のルールをある程度定めることで理解しやすいコードになりうる. いくつか種類が存在する. PEP-8 peps/pep-0008.txt at master · python/peps · GitHub はじめに — pep8-ja 1.0 ドキュメント Google Python
「IT英語スタイルガイド」は、日本語ネイティブ向けの英語スタイルガイドです。ITプロフェッショナルが英語ドキュメントを書く際に、表記基準として参照してもらうことを目的としています。 あくまで表記を統一するための目安であり、「正しい英語」を提示しているわけではない点にご注意ください。「いくつか書き方はあるけど、バラバラだと困るから統一しよう」という場面で参考にします。 内容本スタイルガイドは、次の内容で構成されています。メニューから各ページにアクセスしてください。 A. ドキュメント要素見出し、表、リストなど、ドキュメントを構成する要素の書き方について説明しています。B. 句読点と記号コロン、セミコロン、チルダなど、句読点と記号の使い方について説明しています。英語で使わない記号についても触れています。C. 定型情報日付や数など、定型情報の書き方について説明しています。D. 分野特有の書き方
ReactやVue.jsなどのライブラリ/フレームワークが普及し、コンポーネント単位でUIを設計・実装するフロントエンド開発が一般的になってきました。しかし、コンポーネント単位での開発には様々な悩みポイントがあります。 コンポーネントには、単純に見た目の情報だけを持っているものもあれば、それぞれが状態を持っていてその状態によって見た目や振る舞いを変化させたりするものもあります。そういったコンポーネントは、他のコンポーネントと連携しても見た目や振る舞いが壊れないように(壊さないように)実装しなければいけません。 コンポーネント単位のフロントエンド開発において、コンポーネントを独立させて管理するスタイルガイドを作成することは必須と言っても過言ではありません。本記事では、スタイルガイドを作成するためのオープンソースツールであるStorybookを紹介します。 村上 玄徳氏 株式会社メンバーズ メ
こんにちは。印刷のラクスルでフロントエンドを担当している菅野です。 2週連続の投稿となります。(前回の記事: Jestを実行した時に、同時にESlintを走らせてみる) 現在、印刷サービスのフロントエンドエンジニアとデザイナーでデザインシステムの構築・整備を行っています。 その一環として、運用中のCSSスタイルガイドをStorybookに移行しました。 今回は、移行を決めた動機や導入時に得られた知見、今後の運用についてご紹介したいと思います。 [caption id="attachment_4313" align="alignnone" width="1024"] 運用中のStorybookの画面[/caption] これまでのスタイルガイドにおける課題感 該当プロジェクト(印刷のラクスル)ではPostCSSを使用しており、社内でデザインのコンポーネント一覧を共有するために、postcss
Matthias Noback 著、田中 裕一 訳 2023年7月7日発売予定 328ページ ISBN978-4-8144-0033-1 定価3,520円(税込) オブジェクト設計において、コードの読みやすさ、書きやすさ、メンテナンス性を向上させるにはどうすればよいでしょうか? 本書は、より良いオブジェクト指向のコードを書くためのルールを紹介します。オブジェクトの種類に応じたオブジェクトの構築、メソッドの定義、状態の変更や公開など、設計ルールを説明します。Java、Python、C#など、あらゆるオブジェクト指向言語に適用できるテクニックを、擬似コードを使ってわかりやすく解説します。コードの品質を上げるためのルールを紹介する本書は、プログラマ必携の一冊です。 全国の有名書店、Amazon.co.jpにて予約受付中です。
概要 CC BY 3.0ライセンス(Attribution 3.0 Unported)に基づいて翻訳・公開いたします。 英語記事: toptal/active-job-style-guide: This Background Jobs style guide is a list of best practices working with Ruby background jobs. 原文更新日: 2020/07/17 著者: Phil Pirozhkovほか 本スタイルガイドは、バックエンドにSidekiqを用いたActive JobでRubyバックグランドジョブを扱うときのベストプラクティスを一覧できるようにしたものです。 一般に思われているのと異なり、このガイドラインに沿うことでかなりうまくやれるようになります。 SidekiqはActive Jobなしでも使えますが、Active J
オブジェクト設計において、コードの読みやすさ、書きやすさ、メンテナンス性を向上させるにはどうすればよいでしょうか? 本書は、より良いオブジェクト指向のコードを書くためのルールを紹介します。オブジェクトの種類に応じたオブジェクトの構築、メソッドの定義、状態の変更や公開など、設計ルールを説明します。Java、Python、C#など、あらゆるオブジェクト指向言語に適用できるテクニックを、擬似コードを使ってわかりやすく解説します。コードの品質を上げるためのルールを紹介する本書は、プログラマ必携の一冊です。 まえがき 序文 本書について 1章 オブジェクトを使ったプログラミング入門 1.1 クラスとオブジェクト 1.2 状態 1.3 振る舞い 1.4 依存関係 1.5 継承 1.6 ポリモフィズム 1.7 コンポジション 1.8 クラスの整理 1.9 Return文と例外 1.10 ユニットテスト
はじめに 2020年10月、Githubがデフォルトのメインブランチ名をmasterからmainに変更しました。理由は、masterがslave(奴隷)を背後に連想させるため。 旧来の価値に根差した既存の用語を置き換える動きは、2020年を契機としてますます勢いを増し、その影響は仕様の策定から命名規則などのコーディング面にまで幅広く及んでいます。 こうしたアメリカのテック界の様相をInclusive Writingの切り口から、Google, Appleのスタイルガイドを摘要しながら概観するのが本稿の趣旨です。 Inclusive Writingとは? Inclusive Writingはかんたんには、多様な読者を意識した書き方、といえます。 Inclusiveは日本語でも「インクルーシブ教育」等、ダイバーシティの文脈でカタカナ語として定着しつつありますが、強いて訳せば「包含、包み込む」と
[目次] 1. ワイヤーフレームに画像を配置する 2. アセットパネルにスタイルを登録する 3. コンポーネントを作成する 4. レイヤーパネルを使う 1. ワイヤーフレームに画像を配置する 前回作成したトップページのワイヤーフレームに画像を配置します。配置する箇所は、メインビジュアルとバナーの2か所です。 メインビジュアルとバナーの2か所に画像を配置する シェイプに画像を配置する まず、メインビジュアルの位置に画像を配置します。XDでは、シェイプに画像ファイルをドラッグ&ドロップすることで、シェイプ内に画像を配置できます。そこで、メインビジュアルとして配置されているシェイプ(長方形)の上に適当な画像を移動してみましょう。すると、長方形が半透明の青色でハイライトされた状態に変化し、画像をドロップできることを知らせてくれます。そのまま画像をドロップしましょう。 画像をシェイプにドラッグして配
ブログ HubSpot日本語ブログでは、世界中のHubSpotの知見を活かし、日本のビジネスパーソンの課題解決に繋がるような情報を提供しています。
アプリを開発する前に予め、開発の全体像を把握するためにプロトタイプを作成します。 プロトタイピングツールで作成したUIは、実際のアプリ開発にも流用できるため効率的です。 今回は簡単な写真共有Webブラウザアプリを制作すると仮定して、 プロトタイピングツールFigmaでプロトタイプ作成 Reactコンポーネントへの落とし込み Storybookでの管理 という一連の流れを実際に実装しながらFigmaやStorybookを導入することでどういったメリットがあるのか・どういったことができるのかの検証を行います。 作成したプロトタイプの全体像 最初にどんなアプリなのかをスクリーンショットで提示してから、詳細な解説を進めていきます。 基本的なアプリに最低限必要な認証・一覧表示・登録・編集 機能をプロトタイピングで再現しました。 マテリアルデザイン(Material-ui)をベースとしています。 ログ
風音屋では、データエンジニア、データアナリスト、データコンサルタントを募集しています。 書籍執筆者やOSSコントリビューターなど、業界を代表する20名以上のアドバイザーと一緒にベストプラクティスを追求できる環境です。 ぜひカジュアルトークをお申し込みください。 兼業データアナリストの星野(@mochigenmai)です。 この記事では dbt 開発で使える SQL スタイルガイドを導入した話について紹介します。 SQL スタイルガイドを導入した背景 現在 dbt を利用したデータパイプライン開発が活発になってきています。 データパイプラインは「信頼性の高い分析」を効率的かつ迅速に実現するために構築します。 そのため、データの信頼性を担保する仕組みは積極的に導入したほうが良いと考えられます。 今回は以下のような点でデータの信頼性を担保できると考え、 dbt 開発環境に SQLFluff (L
世間一般では「スタイルガイド」というと、大規模サイトや長期間運用するサービスのためのものが多いようです。私が作っているのはそこまで本格的ではないので、社内では「パーツ集」と呼んでいます。 それまでの課題 パーツ集を作る前は、コーディング担当者とのすれ違いがありました。 アニメーションを作っても気付かれない ドロップダウンやボタンのアニメーションをプロトタイプで作っておいても、実装者に気づかれず「ここどうするの?」と聞かれることもありました。 ドキュメントアセットを見てね、は通じない XDのドキュメントアセットのカラーや文字スタイルに命名してテキストスタイルを登録しておいても、行間や書体が違ってしまうことも悩みでした。文字間(letter-spacing)などは特に空気! 自分の一貫性も揺らぐ 初案を作ってから次のデザイン時まで期間が空いたりすると、自分でもデザインの一貫性が保てないことも課
(原文) How to Create a Style Guide to Enhance your Brand’s UX? UXやUIの世界では、プロジェクトを始める時に頭に置いておきたいのが、スタイルガイド。今回はスタイルガイドのメリットと作成のヒント、サンプルを紹介します。 人間のオンライン行動の詳細を把握するための綿密な計画/調査/テストを含むUXプロセス全体は、企業がコンバージョンを得る一方、ユーザーがサイト検索の目的を果たすために行われます。双方にとってメリットのある状況です。しかし、それを実現するためには、再現性のある結果(成功)をもたらすプロセスが必要なのです。 スタイルガイドとは スタイルガイドとは、制作のデザインルールブックです。一貫したデザインシステムを構築、デザインや実装のアイデアを定義し、優れたコンテンツを生み出すことができます。デザイナーやエンジニアチームの生産性を
Airbnb JavaScript スタイルガイドのうち、eslint でカバーできないルールのみを集めました。 Types 1.1 1.2 References 2.3 Objects 3.2 3.5 3.8 Arrays 4.2 4.3 4.4 4.5 4.6 4.8 Destructuring 5.3 Strings 6.2 Functions 7.4 7.5 7.7 7.8 7.9 アロー関数(Arrow Functions) 8.3 Classes & Constructors 9.1 9.2 9.3 9.4 Modules 10.1 10.2 10.3 10.8 Iterators and Generators 11.2 Properties 12.2 Variables 13.3 13.4 Hoisting 14.1 14.2 14.3 14.4 Comparison Ope
RSCSSの概要 RSCSS(Reasonable System for CSS)は、厳選したルールセットのCSSアーキテクチャです。BEMのコンポーネントを参考にComponents、Elements、Variantsの分類が用意されていますが、BEMのとっつきにくいクラス名のルールは使っていません。 CSSアーキテクチャで個性がでるのがクラス名の定義です。RSCSSはすべてにおいてシンプルを目指しているので、クラス名もかなりシンプルなルールになっています。RSCSSのクラスはマルチクラス前提として、クラス名が長くなるのを避けるためにCSSのネストと子セレクタ(>)の利用を推奨しています。 RSCSSの公式ドキュメントにて、RSCSSはフレームワークではなく、保守性の高いCSSを構築するためのアイディアセットと紹介しているだけあって、規則はミニマムです。規定されていない部分を補う必要があ
デザインシステム、パターンライブラリ、コンポーネントライブラリ、スタイルガイドという言葉は、よく同じ意味で使われているのを見かけます。これら4つの概念は関連していますが、同じものではありません。 また、デザインシステムとコンポーネントライブラリの違いについてもわかりづらいと思う方も多いかもしれません。デザインシステムにはコンポーネントライブラリがありますが、コンポーネントライブラリもまた、独立したエコシステムです。(例:MUIやReact-Bootstrapなど) 上記の違いが現時点でわからないという方も、ご安心ください!この記事では、これらの4つの用語を定義しながら違いをわかりやすく説明していきます。また、デザインシステムとコンポーネントライブラリの各メリットや、デザイナーと開発者がこれらをどのように使い分けるかについても解説してきます。 世界で最も種類が豊富であるコンポーネントライブラ
キャピタリゼーションキャピタリゼーションとは、単語の最初の文字を大文字にするかどうかの規則です。センテンス・スタイルとタイトル・スタイルの2種類があります。 通常、タイトルと見出しでは「センテンス・スタイル」を用います。センテンスと呼ばれますが、文ではないので末尾にピリオドは付けません。 センテンス・スタイル最初の単語だけ大文字を使い、残りの単語は小文字を使います。通常の文と同じ形となるので、センテンス・スタイルと呼ばれます。 例1 Develop high quality solutions with ease (引用元:Google Developers、2023-02-09閲覧) ただし、固有名詞(例:製品名、社名、国名)などで、大文字が正式な表記である場合は大文字とします。例2では「Flutter」です。 例2 Create and run a simple Flutter a
Storybookとは Storybookとは保守性の高いUIコンポーネント(スタイルガイド)を素速く簡単に構築するためのツール。 オープンソースなので商用でも無料で使用することが可能。 Storybook for HTMLといってもHTMLだけではなくCSSやJavaScriptのスタイルガイドも構築できる。 昔はFractal、sc5-styleguide、kss-nodeなどがよく使用されていたが、2020年現在では新規のプロジェクトの場合はStorybookが使用されることが多い。 React、Vue.js、Angular用などがあるが、この記事で説明するのは一番需要がありそうなHTML用のStorybook for HTMLのインストール手順と基本的な使い方。 Vue.jsなどの場合は公式サイトトップの右下のMADE FORのVueのリンク先にある説明手順に従ってインストールする
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く