やってみる

アウトプットすべく己を導くためのブログ。その試行錯誤すらたれ流す。

Calcにおける命名規則

 Calcには名前をつけるべき要素がある。どのように名付けるべきか。

結論

対象 命名規則
ファイル名 小スネークケース file_name.ods
シート名 小スネークケース sheet_name
セル範囲名 小スネークケース cells_name
ユーザ定義関数名 大スネークケース DO_SOME
スタイル名 キャメルケース MyStyle

 ファイル名、シート名、セル名、関数名はすべてスネークケースで名付けるべき。大文字・小文字を区別しないから。

 スタイル名はキャメルケースにすべき。大文字・小文字を区別するから。既存スタイルもキャメルケースだから。

理由

理由

  • アルファベットの大文字と小文字を区別しないから
    • ファイル名
      • OSやそのファイルシステムによって大文字・小文字を区別したりしなかったりする
        • 使える文字種が少ない方に合わせるべき
          • さもなくば同一ファイル名と識別されてしまう場合がある
            • すべて小文字または大文字に統一する
              • スネークケースがふさわしい
              • キーボード入力は小文字がデフォルトである
                • 小文字スネークケースに統一するのがよい
    • シート名、セル名
      • 大文字・小文字を区別しない
        • 小文字スネークケースに統一するのがよい
    • ユーザ定義関数名
      • システム関数名はすべて大文字である
        • ユーザ定義関数名もそれを踏襲する
          • 大文字スネークケースにする

名前をつける項目

大文字・小文字を区別しない

 Calcには名前をつける項目がいくつかある。これらは大凡「大文字・小文字を区別しない」。

対象 大小
ファイル名
シート名
セル範囲名
ユーザ定義関数名
スタイル名
  • 大小: アルファベットの大文字と小文字を区別する

使える記号が少ない

 名前をつける項目はそれぞれ、使える記号が異なる。ルールは非常に複雑。

 たとえばファイル名は、OSやファイルシステムによって異なる。シート名には[など使えない記号がいくつかある。セル名は.が先頭や末尾には使えない等。

 個別に細かく覚えるのは不可能。それでも統一性を持たせたい。迷わず読み書きできて一意に特定できるよう機能的な命名規則を定めたい。そこで、画一的に以下のような正規表現で覚える。

[_a-z][_a-z0-9]*

 これはC言語などプログラミング言語における変数名のルールとほぼ同じ。それの大文字・小文字が区別できない版。

 ただしスタイル名だけはキャメルケースとする。これは既存のスタイル名を真似すればいい。

 連番で名付けたいときもある。じつはファイル名、シート名、スタイル名は先頭に数字が使える。セル名と関数名は使えない。

 なら、次のように覚えれば良い。

対象 命名規則 正規表現
ファイル名 小スネークケース [_0-9a-z]+ 01_file_name.ods
シート名 小スネークケース [_0-9a-z]+ 01_sheet_name
セル範囲名 小スネークケース [_a-z][_a-z0-9]* cells_name
ユーザ定義関数名 大スネークケース [_A-Z][_A-Z0-9]* DO_SOME
スタイル名 キャメルケース [_0-9a-z]+ 01_MyStyle

対象環境

$ uname -a
Linux raspberrypi 5.4.51-v7l+ #1333 SMP Mon Aug 10 16:51:40 BST 2020 armv7l GNU/Linux