CorelDRAWでマクロを利用するためのドキュメント「6.4 - Providing documentation for macros」の和訳です。
注記:このトピックは、JavaScriptスクリプトに適用できません。
マクロをできる限りユーザー・フレンドリーにするには、あなたは、そのために文書を提供することができます。
1つの解決策は、Readmeファイルや印刷されたマニュアルを作成することです。別の解決策は、マクロのために、直接文書をユーザー・インターフェイスに取り込むことです。しかし、このメソッドは、画面上の貴重な「不動産」を使い果たします。さらにもう一つの解決策ンは、オンライン・ヘルプ・システムを作成することですが、この方法では、特別なツールとかなりの追加作業が必要です。
おそらく、マクロ文書を提供する最も単純な方法は、プレーンテキスト・ファイルの形式です。実際には、インストール時に、マクロ・プロジェクトは、このファイルの場所を指すレジストリ値を作成することができます。VBAでは、次の関数は、プレーンテキスト・ファイルを開くために使用することができます。(パラメータ・ファイルは、C:\ReadMe.txtのような、ファイルへのフルパスを提供します。):
Public Sub launchNotepad(file As String)
Shell "Notepad.exe" & " " & file, vbNormalFocus
End Sub
より強力な解決策は、HTML形式で文書を提供することです。HTMLは、プレーンテキストよりも、グラフィックス、そして、ハイパーテキスト・リンクのサポートを含む数多くの利益を提供します。(文書内の特定の場所など-たとえば、index.html#middle)。VBAでは、次の関数は、HTMLファイルを開くために使用することができます。(パラメータurlは、ファイルへのフルパスを提供します。-C:\ReadMe.txtのような、):
' すべてのSubとFunctionの前に、このDeclare文を配置します!
' Put this Declare statement before all Subs and Functions!
Declare PtrSafe Function ShellExecute Lib "shell32.dll" _
Alias "ShellExecuteA" (ByVal hwnd As LongPtr, _
ByVal lpOperation As String, ByVal lpFile As String, _
ByVal lpParameters As String, ByVal lpDirectory As String, _
ByVal nShowCmd As Long) As LongPtr
Public Sub launchBrowser(url As String)
ShellExecute 0, vbNullString, url, vbNullString, vbNullString, 5
End Sub