読者です 読者をやめる 読者になる 読者になる

MyEnigma

とあるエンジニアのブログです。#Robotics #Programing #C++ #Python #MATLAB #Vim #Mathematics #Book #Movie #Traveling #Mac #iPhone

MATLAB Programming Style Guidelines 3: Constants and Structures

MATLAB

この記事は,

Datatool社のRichard Johnson氏が書いた

"MATLAB Programming Style Guideline"

を自分なりに翻訳したものです.



この文書は

MATLABのコードをより素晴らしいものにするための

多数のコーディング作法について書かれています.



翻訳結果は以下の各リンクから読むことができます.

0. MATLAB Programming Style Guidelines : About This Document - MY ENIGMA

1. MATLAB Programming Style Guidelines : Introduction - MY ENIGMA

2. MATLAB Programming Style Guidelines : Naming Conventions - MY ENIGMA

3. MATLAB Programming Style Guidelines : Constants and Structures - MY ENIGMA

4. MATLAB Programming Style Guidelines : Functions - MY ENIGMA

5. MATLAB Programming Style Guidelines : General - MY ENIGMA

6. MATLAB Programming Style Guidelines : Files and Organization - MY ENIGMA

7. MATLAB Programming Style Guidelines : Statements - MY ENIGMA

8. MATLAB Programming Style Guidelines : Layout, Comments and Documentation - MY ENIGMA



もし,これらの文章に意見や質問,誤謬などがあれば,

それぞれの記事にコメントしてもらえると幸いです.



また,今回の一連の文章は

リンクフリーです.

また,出典を明確にして頂ければ,

内容の転載も可能です.

その際は,コメント欄を利用して一言お願いします.



この"MATLAB Programming Style Guideline"の英語の原本は

以下のリンクからダウンロードできます.

・MATLAB Programming Style Guidelines - File Exchange - MATLAB Central

・Datatool社のHP

・PDFファイルへの直リンク



また,Richard Johnson氏は,

より詳細なMATLAB Programming Style Guidelineを広めるために,

以下の本を出版しています.

The Elements of MATLAB Style
The Elements of MATLAB Style

もし,より深くMATLABのプログラミング作法を学びたい方は,

こちらも参考にすると良いと思います.



最後に,

今回の翻訳は,Richard Johnson氏に直接許可を頂いています.

Richard Johnson氏の寛大な心と素晴らしい仕事に,

深く感謝します.


Constants

ルール1: 定数(グローバルも含む)の名前は,すべて大文字でアンダースコアで単語を分ける.

これはC++の開発コミュニティにおいて,

使用されているルールです.



しかし,円周率のpiのように,

Math Worksは小文字で表記されている定数を使用しています.

しかし,確認してみるとわかりますが,

このようなビルドイン定数は,MATLAB内では関数として定義されています.



定数表記の例

ex) MAX_ITERATIONS, COLOR_RED


ルール2: 同種類の複数の定数では,種類を前に書く

ある定数の種類で,

それぞれ個々の値を持つ定数の名前では,

一般的な定数の種類を表す名前を,

名前の前につけましょう.

ex) 各色の情報を持つ定数の場合:COLOR_RED, COLOR_GREEN, COLOR_BLUE


Structure

ルール1: 構造体の名前は大文字で始める

これもC++のスタイルルールで使用されているものです.

これによって,構造体と通常の変数を簡単に見分けることができます.


ルール2: 構造体の名前は包括的なものにし,フィールド名の中には含めない.

以下のように,

フィールド名に重複するような名前をつけるのは止めましょう.

ex) ◯:Segment.length ×:Segment.segmentLength