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

MyEnigma

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

MATLAB Programming Style Guidelines 5: General

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氏の寛大な心と素晴らしい仕事に,

深く感謝します.


General

ルール1: 単位を持つ変数や定数には,できるだけ単位を末尾に入れる.

基本的にコードの中で使用する単位は,

たった一つのものを使用するというのが理想です.

しかし,実際にはそんなに上手くいかないものです.



そんな時に,変数や定数の名前の末尾に単位を入れると,

避けられない単位の混在による問題を解決することができるでしょう.

ex) incidentAngleRadians


ルール2: 名前の略語は控えるべき

名前を略さずに表記することは,

コードの曖昧さを減らし,

コードそのものを自身のドキュメント化する助けになります.

ex) ◯ computearrivaltime(.) × comparr(.)



しかし,一般的によく知られている略語やアクロニムは,

そのまま表記すべきです.

しかし,そんな時でも,これらの略語やアクロニムが初めて使われた時には,

その定義をちゃんとコメントとして表記することをオススメします.

ex) html, cpu, cm


ルール3: 名前は発音できるようなものにすること.

関数や変数などの名前は,

その名前を読んだり,覚えたりするのを楽にするために,

できるだけ発音しやすいものにすべきです.


ルール4: すべての名前は英語で表記しましょう.

MATLAB界隈のドキュメントはほぼ英語で書かれています.

なので,国際的に使用されるコードを目指すために,

英語で表記しておくのが良いでしょう.