LotusNotesな日々IBM社のLotusNotesに関係する何かを日々語ってるようなきがしないでもないブログです。 

スポンサーサイト

   ↑  --/--/-- (--)  カテゴリー: スポンサー広告
上記の広告は1ヶ月以上更新のないブログに表示されています。
新しい記事を書く事で広告が消せます。

(記事編集) http://mesosune.blog123.fc2.com/?overture" target="_new

--/--/-- | Comment (-) | HOME | ↑ ページ先頭へ |

【Notes】LotusScript/Notes的プログラミングお作法?

   ↑  2007/11/24 (土)  カテゴリー: Notes(その他)
以下はNotesにおいていえること。
人のかいたスクリプトとかみてて思うのでちょっとかいてみる。

他の言語でもいえることや細かいことは省略しています。
気になった方はこちらをご参照のほどを→ウィキペディア

※※※事前にプログラミング作法(ルール)は取り決めておくべきです。※※※※
Notesにかかわる方はどうにもあまりそういう取り組みを行わずに開発や改変を行うことが多いようです。
本来ならば、作法以外にも
変更記録のとり方(成果物のコンセンサス(物理的))、進捗の度合い(意識的なコンセンサス)等
プロジェクト上きめなければならないことは結構あるのですが、
行わずに進めて後で詰まるということも往々としてあるようです。

…………ウチだけw;?

----------------------------
(1)コメントを書きましょう。
----------------------------
容量が…とかいって書かない人がいるのですが、
コメントなんて処理の重さと比べれば些細なもんです。
引継ぎや、変更管理、自分の意思を固めるためにもたとえ@式を書くフィールド内でもでもきちんと書いたほうが良い。
(ただし、LotusScript上の%REM~%End REMはメモリ容量を相当使うので、'を使ったほうがなおよし)

英語でコメントを書くことが望ましいのですが、
私は英語が本当に苦手なので、コメントはすべて日本語で記述しています。

私自身LotusScriptとか初心者なので,
日本語でコメントをかいてから作業に入ることもあります。
ここでああしたいなぁとかどうしたいとか書いてから入ったほうが、
その処理はこの言語だとコレというのをかきやすいんですよね。

結果残るのは日本語をプログラミング化していったものになるので、
他のプログラミングが苦手な人にも読みやすいと好評です;

----------------------------
(2)関数名は何をしているか分かるような英語に。
----------------------------
A_Save01、A_Save02とか書いてもあとで自身で混乱する可能性が高いです。
英語でかけとは言わないからせめてアルファベットでなにしてるかわかる関数名にしましょう。

----------------------------
(3)変数名/フィールド名は半角英数で明確に
----------------------------
まず,一文字でかかない!
eとかiとかxとか。いざ検索したい時とか変換したい時にできないです。
間違える元にもなり、本当に本当にホントゥーーーーッによくない。

半角英数文字意外の文字も実は認識しますが半角英数で書くべきで,
適当な文字列よりもパターンをつけて書いたほうがいいです。
(唐突な名前がでてこないようにしたりする。)

※LotusScriptの変数名関数名は大文字小文字を意識しない(以外は意識するので注意)ので、大文字小文字を混ぜて何の処理に使いたいのかをはっきりさせるのもよい。
ただし、今後のNotesそのものの仕様変更を見込んで全て小文字でかいたほうがよりVetter。

※Web化するときはJavaScriptで使用することを考えて設計要素名の設定をおこなう

<<名前をつける時の注意>>
・処理と同じ名前にしない。
・今後のバージョンアップで処理の名前になりそうなものは使用しない。
・あまりにも長くしない(スペルミスの原因となることも?)

----------------------------
(4)上から下へ流れるようにかく、上に設定項目を置く
----------------------------
宣言は宣言で、処理はできるだけまとめてかくべきです。
人間でも宣言がまとまってないと上を確認しながらになってしまいますが、
実行側も同じだということを忘れてはいけません。

Cとかだと、関数は先にかいておかないと動かないとかがあります。
LotusNotesはそこらへんの配慮を自動でしてくれているだけだと思えばよいかと。

Notes上でもなりますが特にWeb上では、フィールドの位置関係によっては値が自動で(Domino上で)引き継がれないとかがありますので注意が必要です。
たまに「べき」口調ですが,あくまでも"作法"なので「絶対こうすべき!」といいたいわけではありません。
改変が入ったことを考えると,これは認識しつつやったほうがいいですよと思うのでかいています。

-----

伏線=関数と考えると、
プログラムをかくのは小説をかくのに似ていると思います。
上から下へ右から左へ、読む人(プログラム実行側)の目が流れるものがよく、
短い言葉で具体的な表現ができているものが「美しい」、
長いけれど疲れない文書が「楽しい」。
覚えてなければいけない登場人物が少ないほうが読み進める時は楽で早くなる。

そう考えるとプログラムにも「センス」が必要というのもなんとなく分かりませんか?
「センス」がなければ、センスを学んでみにつけりゃーいいのです。

そんな私にはネーミングセンスが無いので、変数の名前きめで頭をひねる日々です。
スポンサーサイト

(記事編集) http://mesosune.blog123.fc2.com/blog-entry-28.html

2007/11/24 | Comment (0) | Trackback (0) | HOME | ↑ ページ先頭へ |

Comment

コメントを投稿する 記事: 【Notes】LotusScript/Notes的プログラミングお作法?

お気軽にコメントをぞうぞ。
非公開 (管理人のみ閲覧可能なコメント) にしたい場合には、ロック にチェックを入れてください。

  任意 : 後から修正や削除ができます。
  非公開コメントとして投稿する。(管理人にのみ公開)
 

Trackback

上記広告は1ヶ月以上更新のないブログに表示されています。新しい記事を書くことで広告を消せます。