35

Home

みてるぞ edited this page 2024-05-15 19:17:33 +09:00

Table of Contents

• ニジカもんすたぁ!! 開発 Wiki
• 目次
• 開発手順
• 環境構築
• ブランチ名命名規則
• コーディング・スタイル
• 共通の基本事項
• PHP
• JavaScript

ニジカもんすたぁ!! 開発 Wiki

ここはニジカもんすたぁ!! 開発者向けの Wiki です．

みんなが気持ちよく開発できるように，このページにざっと目を通してからの参加をお願いします．

目次

• 開発手順
• コーディング・スタイル

開発手順

GNU゛U゛U゛U゛/Linuxを想定して書きますが，macOS や Windows の方も同じようにできると思います．

環境構築

作業用のディレクトリに移動し，以下のコマンドを実行します．

git clone https://git.miteruzo.com/miteruzo/nizika.git

ブランチ名命名規則

ブランチ名は，NIZIKA_DEV-{課題番号（3 桁）} とします． たとえば，課題番号 245 に対するブランチは，NIZIKA_DEV-245 となります．

自由でいいよ．

コーディング・スタイル

原則，GNU゛U゛U゛U゛スタイルに従うものとします（えぇ，これが言いたかっただけです）．

ただし，GNU゛U゛U゛U゛スタイル（まだ言うか）は C のためのコーディング・スタイルですから，このプロジェクトで用いる言語（PHP、JS など）では修正が必要です．

補足が必要な箇所のみ以下に示します．

共通の基本事項

ブロック内が 1 行のみの場合，冗長な波括弧を記述しないでください．

たとえば，以下のようにはしないでください：

if (a === b)
  {
    thenProcess ();
    afterProcess ();
  }
else
  {
    elseProcess (); // だめ．
  }

代わりに，次のようにしてください：

if (a === b)
  {
    thenProcess ();
    afterProcess ();
  }
else
  elseProcess (); // 👍

ただし，1 行あたりの文字数が 80 字を超えるなどの理由で，1 文を 2 行以上にわたり記述するような場合であれば，冗長な波括弧を追加し，ブロックの範囲を明確にしてください．

たとえば，次のようにします：

if (a === b)
  {
    superHyperLongNameMethod (superHyperLongNameArgument1,
                              superHyperLongNameArgument2,
                              superHyperLongNameArgument3);
  }

PHP

変数名、メソッド名はスネーク・ケースで記述し，クラス名はパスカル・ケースで記述するものとします．

函数の宣言は，以下のように記述します：

function
the_function (
    int     $arg_a,
    string  $arg_b)
: bool
{
  hoge ();
}

JavaScript

変数名、メソッド名はキャメル・ケースで記述し，クラス名はパスカル・ケースで記述するものとします．

函数の宣言は，以下のように記述します：

function
theFunction (argA, argB)
{
  hoge ();
}

TypeScript の場合は，かならず型を明記し，次のやぅにします：

function
theFunction (
    argA:   number,
    argB:   string)
: boolean
{
  hoge ();
}