FileMaker script commenting conventions

Beginner

Comments make scripts maintainable. Learn the # Comment step, the standard documentation header, and when a comment adds value vs when it just adds noise.

What you'll learn

How to use the # Comment step in FileMaker scripts
The standard documentation header format
When to comment and when to let clear code speak for itself

The # Comment step is FileMaker's dedicated script comment — use it for a documentation header at the top of every script and inline comments that explain why, not what.

1/3

Write the standard documentation header

Every script should open with a # Comment step containing the purpose, parameter contract, and result contract. This is the first thing another developer reads.

FileMaker Script

# ——————————————————————————————————————
# Purpose:          Create a new invoice for a customer
# Parameters (In):  { customerId, lineItems[], notes }
# Parameters (Out): { success, invoiceId } on success
#                   { success: false, error, message } on failure
# Called by:        Order Submission workflow, Quick Invoice button
# Last modified:    2024-11-15  A. Riley
# ——————————————————————————————————————

Window management in FileMaker: New Window, Adjust Window, Close Window Commit Records/Requests: when and how to commit in FileMaker scripts