コーディング規約

if文for文の後ろは単文のみ許可、長くなる時は{ }でくくる というマイルール { は絶対次の行にしない。（関数宣言のときは逆に { を必ず次の行にする） 許さない書き方 /* 見つけ次第直す */ if(a>0) hoge(); for(i=0; i<10; i++) hoge(); /* 書いたやつを地の果てまで追い詰め吊るす */ if(a>0) hoge(); else piyo(); /* 自分ではこう書かない */ if(a>0) { hoge(); } if(a>0) { hoge(); } else if(a==0) { piyo(); } else { fuga(); } …

こんにちは、弊社サービスのインフラを運用している id:keijiu (ijikeman)です。 今回は、「ラクスサービスを管理するAnsibleコードの共通テンプレートを作った話」を記載します。 [対象読者] 対象読者: Ansibleでサーバの管理を行っている人 またはこれから行いたいと考えている人 記事を読んでわかること: Ansibleの実装方法(汎用化) パラメータ(vars)の記載箇所 Ansibleの学習資料の作成 Ansibleコード規約

Da Vinci Studio データ分析チームの濱口です。 現在データ分析チームで運用されている SQL のコーディング規約について紹介します。 なぜコーディング規約を定めるのか SQL のコーディング規約を定める主な理由として、 可読性を上げるというのがあると思います。 スタイルを統一せず、書き手によって異なるスタイルで書いていると以下のような弊害が発生します。 レビューしづらい 他の人が書いた別の作業の SQL というだけでも読みづらいですが、コーディングスタイルが揃っていないとさらに読みづらくなってしまいます。 そうするとレビューにも時間がかかってしまい、他の作業に割ける時間が短くなっ…

コーディング規約 ■前書き 昨今のプログラム開発における記載ルールは、言語特性やIDEのタイピング補完機能などにより、統一した記載ルール（コーディング規約）を明確にすることで、高速で品質の高いプログラム作成が可能となる。OSや言語の違いにより、使われるルールが変わってくるため、どの場合にはどのようなルールで記載するのかを明確にし、統一された品質の高いプログラム作成の一助となるよう、細部にまでルールを検討したものである。 ■基準となる命名規約 現在、プログラム開発における命名規約は、「ハンガリアン」「パスカル」「キャメル」「スネーク」の４種類が存在している。 それぞれの特徴を把握し、ファイル名、…

Flutter/Dart講義の1回目。かなり基本的な言語構造から説明をしていきますよ。

どうもこたにんです。 コーディングに正解を求めるのか Kotlinコードを書いたり、Terraform書いたりしてて、ふと思ったんですよね。 コーディングに正解はあるのか 特にTerraform書いてて感じたんですよね。 文法としての正解があり、定義同士のつながりにも正解がある。 必要な機能を満たすために書き上げられるコードは、誰が書いても同じものになる。 書き方が厳密で、そこにアルゴリズムも存在しないため、正解があるなと。 （linterで解決するようなコーディング規約的な部分は省略します） 一方Kotlinでサーバサイドコードを書いてると、そこには正解がないように感じたんですよね。 アーキ…

『アジャイルメトリクス』を少しずつ読んでいます。 アジャイルメトリクス作者:Christopher W. H. Davis翔泳社Amazon 職業がら、最初をすっ飛ばして「品質」の項から手を付けていることもあり、なかなか歯ごたえのある（つまりわたしには難しい）本だなーと噛みしめております。 読み進めていくなかで、「この品質特性、多義的じゃないか？」と感じたものが2つあったので、わたしの理解をメモしておきます。 TL:DR 国内規格で「保守性」といえば、コードの修正のしやすさ。運用の仕方ではない。 「拡張性」は、外部品質的なscalabilityと、内部品質的なextensibilityのどちら…

はじめに こんにちは！モジュール開発部のyamakazu (@yamarkz) です。 10Xではテストコードの標準化を目指して、テストコード規約 (Test Coding Standards) を整備してきました。この記事では数ある規約の中でも、実際に活用して効果が大きかったものをいくつか取り上げて紹介します。 テストコードの品質に課題を持っている方や、コーディング規約の整備に関心を寄せる方の参考になれれば幸いです。 ChatGPT 要約 ChatGPTに内容の要約をお願いしました。この記事で述べられている内容は以下の通りです。 テストコードに規約を設ける目的は、「テストの資産性を高めること…

ネイティブアプリエンジニアの入江です。 OpenWorkのiOSアプリのアーキテクチャは、MVVMからTCA(TheComposableArchitecture)へ移行中です。 今回は初投稿ということで、実際TCA化やっていてどうかみたいな、広く浅いテーマの記事にしたいと思います。 ※この記事でいう「テスト」とは、XCTestを利用したビジネスロジックのテストを指します。 技術選定 リファクタの一番最初のきっかけ 自分はTCA化がはじまった当初には在籍していなかったのので、リアーキテクチャキックオフ当時の資料を探してみました。 その資料によると、一貫して「規則が守られない」ということが残されて…

PERとは PER（PHP Evolving Recommendations）は、PHPの開発者コミュニティによって提案され、討議された、将来のPHPの進化に関する提言集です。PHP言語の進化を促進することを目的に、PHPのコア開発者やコミュニティの開発者たちが、新しい機能や構文、標準ライブラリの改善などを提案しています。 PERは、PHP言語の進化についてのコミュニティの意見をまとめたもので、PHPの開発者が機能追加や改善を行う際に、重要な参考資料となります。PERに含まれる提言は、PHPの開発ロードマップの策定や、新しいPHPのバージョンのリリース時期の決定などに役立ちます。 PSRとは …

はじめに こんにちは！ モジュール開発部の yamakazu (@yamarkz) です。 チームのサイドプロジェクトでLint Ruleの整備を進めてきており、メインプロジェクトを進める傍ら、隙間時間を捻出してはLint Ruleを作っています。 興味本位で始めたLint Rule作りだったのですが、これが思っていた以上に面白く、面白さにハマった勢いで1ヶ月で20以上のLint Ruleを作っていました。 今回はそんな勢いを持って整備を進めていたLint Rule整備の話を取り上げて、そもそもなぜLint Rule整備を始めているのか？Lint Ruleで何を解決したいのか？どういったLin…

はじめに ABAPとは ABAPの特徴 ABAPプログラムの種類 さいごに はじめに初めてSAPシステムの開発を行う方、興味がある方にSAP専用言語であるABAPについて紹介します。 ABAPとはABAPとはAdvanced Business Application Programingの略称で、1979年にSAP社が開発したSAPのシステム開発に用いられるSAP専用言語です。そのため、標準機能はもちろんのこと、アドオン機能もABAPで作成されています。 SAP独自の言語ではありますが、JavaやRubyを学習したことがあれば簡単に扱えるようになると思います。 ABAPの特徴ABAPを使うこと…

コードレビューをする際に、レビュー項目にコーディング規約に則した記述をしているかどうかという物がある。 チェック自体は行った方が保守性が高まり良いとは思うが、人の手で行うとかなり煩わしく、量もあるので時間もかかる。 ルールがあり確認作業も単調なので、どうにか機械的に行う事は出来ないかと調べていたら、C#にはRoslynという構文解析に使えるAPIが備わっているようだったので、試してみた。 今回は、使い方メモ書き、フィールド編。 ハッキリ言って、Roslynがどういう構造で、どういう思想なのかをきちんと理解はしておらず、 とりあえずやりたい事を、こういう風にやった、というメモ書きである。 これか…

コードレビューをする際に、レビュー項目にコーディング規約に則した記述をしているかどうかという物がある。 チェック自体は行った方が保守性が高まり良いとは思うが、人の手で行うとかなり煩わしく、量もあるので時間もかかる。 ルールがあり確認作業も単調なので、どうにか機械的に行う事は出来ないかと調べていたら、C#にはRoslynという構文解析に使えるAPIが備わっているようだったので、試してみた。 今回は、使い方メモ書き、プロパティ編。 ハッキリ言って、Roslynがどういう構造で、どういう思想なのかをきちんと理解はしておらず、 とりあえずやりたい事を、こういう風にやった、というメモ書きである。 これか…

コードレビューをする際に、レビュー項目にコーディング規約に則した記述をしているかどうかという物がある。 チェック自体は行った方が保守性が高まり良いとは思うが、人の手で行うとかなり煩わしく、量もあるので時間もかかる。 ルールがあり確認作業も単調なので、どうにか機械的に行う事は出来ないかと調べていたら、C#にはRoslynという構文解析に使えるAPIが備わっているようだったので、試してみた。 今回は、使い方メモ書き、関数編。 ハッキリ言って、Roslynがどういう構造で、どういう思想なのかをきちんと理解はしておらず、 とりあえずやりたい事を、こういう風にやった、というメモ書きである。 これから使い…