القائمة
Enforce inline commenting conventions for Miden Assembly (.masm) files. Use when editing, reviewing, or creating .masm files.
يُحدَّد Prompt الذي يراجع المصدر أولًا بشكل افتراضي. يمكنك التبديل إلى أمر مباشر أو تنزيل نسخة محلية.
اقرأ SKILL.md وأي ملفات مرافقة يعرضها SkillsMP قبل أن تقرر التثبيت.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
يتجاوز الأمر المباشر Prompt المخصّص للمراجعة. افحص المصدر قبل تشغيله.
npx skills add https://github.com/0xMiden/agent-tools --skill masm-inline-commentsيبقى الأمر في سطر واحد. مرّر أفقيًا لمراجعته كاملًا قبل النسخ.
تفضّل نسخة محلية؟ نزّل الملفات المتاحة حاليًا لدى SkillsMP.
Use when writing kernel, account, or note MASM code that reads from or writes to the advice provider (advice stack / advice map) — validate advice data.
Use when writing or reviewing MASM hot paths — prefer the cheaper equivalent instruction: `neq.0` over `push.0 gt` for non-zero checks, `cdrop` over an `if/else` selecting between two values, `dup.N` over `loc_load` for a value still on the stack, `eqw` over hand-rolled element-wise word comparison, `u32gt`/`u32lt` over generic `gt`/`lt` on known-u32 operands.
Use when writing a GENERIC MASM storage utility (one that operates over a caller-chosen slot or map) inside a reusable account component — receive the slot id as a parameter so the utility works against any slot, not one hard-coded one.
استنادا إلى تصنيف SOC المهني
عرض SKILL.md
| name | masm-inline-comments |
| description | Enforce inline commenting conventions for Miden Assembly (.masm) files. Use when editing, reviewing, or creating .masm files. |
Inline comments (single #) should begin with a lowercase letter.
# good: lowercase start
# remove the asset from the account
exec.native_account::remove_asset
dropw
# => [ASSET_KEY, ASSET_VALUE, note_idx, pad(7)]
# Bad: uppercase start (avoid)
# Remove the asset from the account
Only add comments that provide value. Skip comments for self-explanatory operations. Only apply this rule to new code you write. Do not remove comments that are present in the code.
Skip comments for:
add, sub, mul, divdrop, swap, dupif.true, while.true, endDo comment:
# => [ASSET_KEY, ASSET_VALUE, note_idx, pad(7)]# compute the pointer at which we should stop iterating# => [...] trackersInsert a blank line after a # => [...] stack-state tracker, except when the next non-blank line is one of:
end (proc / while.true / if.true / repeat.N closing).else (note: else is always bare; a false-conditioned branch uses if.false, not an else.* suffix).# => line that continues the same multi-line stack state.# continuation comment that explains the tracker.This pairs each stack state visually with the operation that produced it and lets the eye skim from one labeled state to the next.
Good:
dupw.1 dupw.1
# => [ASSET_KEY, ASSET_VALUE, ASSET_KEY, ASSET_VALUE, note_idx, pad(7)]
# remove the asset from the account
exec.native_account::remove_asset
dropw
# => [ASSET_KEY, ASSET_VALUE, note_idx, pad(7)]
Also OK (no blank line before end or control flow):
# => [pad(16)]
end
Good:
dupw.1 dupw.1
# => [ASSET_KEY, ASSET_VALUE, ASSET_KEY, ASSET_VALUE, note_idx, pad(7)]
# remove the asset from the account
exec.native_account::remove_asset
dropw
# => [ASSET_KEY, ASSET_VALUE, note_idx, pad(7)]
exec.output_note::add_asset
# => [pad(16)]
Avoid:
# Swap the top two elements
swap # swap
# Drop the word
dropw # drops 4 elements