命名規則:LotusScript (変数)

LotusScript で使用する変数は、基本的に次の規則で決定しています。

[接頭語][タグ][基本名][接尾語]

接頭語 スコープやコーディング上の用途を指定
タグ 変数の型を指定
基本名 変数名の本体
用途や役割を簡潔に表した一つまたは複数の単語で構成
接頭語やタグと区別するため単語の大文字で始める
接尾語 類似する変数を複数必要となるなど、基本名が重複する場合に指定
アンダースコアを使って、基本名と区別するとわかりやすい

ただし、ループ変数(ex. i, n など)のようにコーディング上短い変数名の方が可読性が上がる場合は例外とします。


1. 接頭語

スコープや用途により指定する文字です。

接頭語 用途
p
(なし)
パブリック変数は基本使用しないの前提。
作成する場合は、p または 基本名(大文字で開始)で開始させ判別がつくようにする。
(なし) 関数内だけで有効な変数。
可読性、省力化が目的に、付加しない。
v ByVal(値渡し)のパラメータ。
ByVal指定ができないオブジェクトの場合で、関数内でオブジェクト自身を設定しない場合は、v 扱いとする。
r ByRef(参照渡し)のパラメータ。
LotusScript では ByRef の指定はできないが、関数内で値をセットしていることを明示するために指定。
関数内でオブジェクト自身を設定する場合は、r 扱いとする。
x スクリプトライブラリやフォーム内で有効な変数(パブリックではない)。
z クラス変数などスコープがクラス内に限定される場合に指定。
x と区別するために z とする。
c 定数
a 配列


2. タグ

変数の型を表します。


2.1 変数型

タグ 説明
b Boolean
by Byte
d Double
dt 日付/時刻値(宣言は Variant)
i Integer
l Long
sg Single
s String
v Variant
o ユーザ定義型クラスなどのオブジェクト
Variant 型の Excel オブジェクトなどでも使用


2.2 Notes Object Class (バックエンド)

タグ Notes Object Class 名
nacl NotesACL
nacle NotesACLEntry
na NotesAgent
ndb NotesDatabase
ndt NotesDateTime
nd NotesDocument
ndc NotesDocumentCollection
ni NotesItem
nn NotesName
nrti NotesRichTextItem
nrts NotesRichTextStyle
ns NotesSession
nst NotesStream
nv NotesView
nvc NotesViewColumn
nve NotesViewEntry
nvec NotesViewEntryCollection


2.3 Notes Object Class (フロントエンド)

タグ Notes Object Class 名
nuidb NotesUIDatabase
nuid NotesUIDocument
nuiv NotesUIView
nuiw NotesUIWorkspace


2.4 Notes Object Class ( DOM / DXL )

タグ Notes Object Class 名
dan NotesDOMAttributeNode
ddn NotesDOMDocumentNode
den NotesDOMElementNode
dn NotesDOMNode
dnl NotesDOMNodeList
dpars NotesDOMParser
dtn NotesDOMTextNode
dexp NotesDXLExporter
dimp NotesDXLImporter


2.4 Notes Object Class ( HTTP / JSON )

タグ Notes Object Class 名
http NotesHTTPRequest
ja NotesJSONArray
je NotesJSONElement
jnav NotesJSONNavigator
jobj NotesJSONObject

  • NotesJSONArray, NotesJSONElement はいくつも変数宣言をすることになるので短めに設定


2.5 Notes Object Class ( NOMAD 関連 )

タグ Notes Object Class 名
gps NotesGPS
gpsp NotesGPSPosition
gpsc NotesGPSCoordinates

0 件のコメント:

コメントを投稿