タグ検索の該当結果が少ないため、タイトル検索結果を表示しています。
どうも、フリーランスエンジニアの人です。 今まで関わったプロジェクトにおいてコーディングルールが曖昧だった環境で苦労したので、例に出しながら振り返ろうと思います。 ※ 本記事に登場するコード例は実際に存在するコードではありませんがヤバさは忠実に再現しました。 2022/11/5 追記 曖昧かつ実態のズレた変数名 変数の命名というものはエンジニアによって少々偏った傾向が見られますが、その変数が指し示す実態と命名に大きなズレがなく、主旨が伝わればエンジニアリングにおいて大きな問題はないはずです。 ですが、世の中には曖昧かつ実態と一致しない変数名が書かれたプロダクトコードが存在します。 以下のコードをご覧ください。 ※ 今回はJSを例に出します // ユーザーのデータを取得 export const getUserData = async (id) => { const res = await
プロジェクト独自のコーディングルールを簡単に正規表現で定義できる `rubocop-grep` の活用 - ROUTE06 Tech Blog
はじめに: 弊社のとあるEDI(電子商取引)関連のプロダクトでは、Ruby on Railsを利用してGraphQL APIを提供しています。 その開発活動の中で最近、コードの品質と整合性を維持するためのツールとして rubocop-grep を利用し始めました。 この記事ではその具体的な活用事例についてお話しします。 目次 rubocop-grepとは 最初のユースケースと、基本的な使い方の説明 複数のルールをディレクトリごとに設定するための工夫 ほかにどのようなユースケースがありそうか まとめ rubocop-grepとは rubocop-grep は、rubocop の拡張ツールです。 プロジェクト独自のコーディングルールを、正規表現を用いて簡単に定義することができます。 この手の問題は、今までもカスタムCopを書くことで解決することはできましたが、カスタムCopはASTの知識やRu
弁護士ドットコム Advent Calendar 2022 お急ぎの方 リポジトリを用意したので、document/ 配下の coding-standards.md を参考にしてください。 概要 プロジェクトによって色々なコーディングルールがあると思うけど、 PHP初めて触る人に PSR に準拠してね！ってだけじゃちょっと難しい時もある。 ただ1から説明するのはめんどくさい...そういう時のためにmarkdownファイルで独自のPHPコーディングルールのテンプレを作ったので配布します。 参考: 【PSR】PHPの標準コーディング規約 ちなみにルールはその時に独自で決めただけで、PSRに準拠している訳ではありませんのでご注意を コーディングを統一する時のおすすめライブラリ PHP-CS-Fixer 余分な空白改行を削除したり、PSRに準拠した書き方に統一してくれたりする もちろん独自にカスタ
Next.jsで小規模サイト（ブログやコーポレートサイトなど）を複数人で開発する際のディレクトリ構成とコーディングルールをまとめました。 以下の点を意識した構成になります。 小規模サイトの場合、コンポーネントの量は限られるのでディレクトリ構成は複雑になりすぎないようにする → ファイルへのアクセスのしやすさを重視 複数人での開発なので、できるだけ書き方を統一できるようにする → ESLint, StyleLintを導入 CSS設計やベースコーディングに疎くても一定以上の品質を担保できるようにする → jsxコンポーネントとCSSを同じ階層に配置して直感的に編集可能に → Sassを採用するが、SASS記法ではなく扱いやすいSCSS記法を採用 はじめに ディレクトリ構成はこちらの記事を参考にさせて頂きました。とても分かりやすく解説してくれているので是非読んでみてください。 最近はFeatur
わいの考えたさいきょうのコーディングルール
コーディングルールは、チームの生産性を高め、エラーを減少させ、コードの可読性や保守性を向上させるためのガイドラインです。しかし、すべてのプロジェクトや組織が同じニーズを持つわけではありません。以下に示すコーディングルールの観点は一例に過ぎません。これをベースに取捨選択し、あなたのプロジェクトや組織の特性や要件に合わせてカスタマイズすることが重要です。 はじめに プログラミングやソフトウェア開発における学びは、日々の挑戦や試行錯誤の中で獲得されるものです。私自身もまだまだ学び始めの段階で、多くの先輩方や専門家たちには遠く及ばないと感じることも多く、時には絶望する日々を送っています(´∀｀=) しかし、そのような日々の中で一つ明確に感じていることは、コーディングの品質や一貫性の重要性です。チームでの開発においては、全員が共通のルールや規約に従うことで、品質を担保することが可能となります。一方、
import BlogCard from '@/components/mdx/BlogCard' 先日の以下記事の続きです。 主に下記環境および言語を対象とした内容です。 OS：Windows 10 Pro 言語：C# editorconfigで実現できること StyleCopは、C#や.NETのコーディングスタイルを規定するため、警告を表示してくれる editorconfigは、C#や.NETはもちろん、VSCodeのエディタ全般におけるルールを設けるほか、強力なリファクタリング支援を受けることができる ファイル種別毎の設定 .cs, .csproj, .configなど、ファイル毎にルールを分けることができます。 コードの種類によってインデントの数を変えたり、PascalCaseやcamelCaseなどの名前付け規則を振り分けたりできます。 プロジェクト単位での設定など .editor
songmu on Twitter: "新しい言語を学ぶ時に、基本的な構文を把握したら、次に知りたいのは以下のようなことかな。 - 依存管理 - テストの実行方法 - ソースコード配置セオリー - コーディングルールやガイドライン - コードリーディングに適したOSS 他になんかあるかな。"
新しい言語を学ぶ時に、基本的な構文を把握したら、次に知りたいのは以下のようなことかな。 - 依存管理 - テストの実行方法 - ソースコード配置セオリー - コーディングルールやガイドライン - コードリーディングに適したOSS 他になんかあるかな。
前回はローカルルールとは何か？というお話をしました。今回はその中の一つをご紹介します。 Private変数にアンダーバーを付けるというものです。 クラスの中でのみ参照するprivateなフィールドは変数名の頭に「アンダーバー」を付けます。 アンダーバーを付ける利点 このローカルルールの利点はコーディング中にアンダーバーを打ち込むとprivateフィールドがインテリセンスに出てきてわかりやすいというものがあります。インテリセンスとは，コーディング中に「.」ドットを付けると候補になるメソッド名等がリストされますよね。それの事です。「a」と打ち込むと「a」で始まるものや，「a」を含む変数やメソッド名がリストされますが，アンダーバーで絞り込むことで，そのクラスで自分が宣言しているprivate変数がリストされるのでわかりやすくなります。 また，「メソッド内」の変数と「クラス変数」が区別しやすいとい
はじめに 本記事でお話すること 声があがるまでの経緯 アプリケーションの背景 課題 ルール策定、ドキュメント作成へ コーディングルール コーディングスタイル その他 運用中 おわりに はじめに こんにちは！フルサポート開発チーム、エンジニアの下山です。 最近は猛暑のせいでバイクに乗る回数が極端に減っています。早くライダーに優しい気温の季節になってほしいです🥵 本記事でお話すること 今回は、フルサポート開発チームがメインで取り扱う管理画面※1のコーディングルールについてお話します。 ただし、コーディングルールの詳細については触れません。 では何の話をするかというと、そのコーディングルールができるまでの経緯とか背景とか目的とか… そういった事細かにまとめられる機会のあまりない内容についてお伝えしたいと思います。 ※1：管理画面とは弊社スタッフが利用する社内アプリケーションの総称です。 声があ
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
コーディングルールはマジでしっかり決めろって話
PHP初心者とお仕事した時に用意したコーディングルールのテンプレ - Qiita
【小規模サイト向け】Next.js ディレクトリ構成とコーディングルール
editorconfig for VSCodeでコーディングルールを統一
C#コーディングルール_#10_private変数にアンダーバーを付ける｜ピーコックアンダーソン
コーディングルール物語 - VISASQ Dev Blog
cloud.watch.impress.co.jp
b.hatena.ne.jp
h4ppy-marriage.jp
cloud.watch.impress.co.jp
gold-ax.hatenablog.jp
www.world-soccer-fan.com