Comment Helper

Overview

Comment Helper generates plain-English comments for PLC code lacking proper comments. Upload an L5X, pick a routine, generate per-rung comment suggestions, review them, and download a commented L5X for re-import into Studio 5000.

Pairs with Code Analyzer in the inherited-code workflow: Code Analyzer surfaces structural issues; Comment Helper documents the existing logic so you can decide how to act on those findings.

The page shows a four-step indicator across the top: Upload → Generate → Review → Download. You can clear and start over at any step.

Step 1. Upload an L5X or load a saved session

Open Comment Helper from the dashboard. The empty state shows two options side by side.

Upload L5X File on the left. Drop in an .l5x file or click to browse. Comment Helper parses the file and lists every ladder routine it found.

Load Saved on the right. If you have previously saved a comment session (your in-progress accept/edit/reject decisions), its cards show here. Click any card to resume. Click Manage Saved for the full picker with rename and delete.

After upload, a routine picker appears under the upload panels. Each routine shows its name, parent program, rung count, and number of uncommented rungs. Comment Helper operates on one routine per run, not on the whole program at once.

Click Continue to move to Generate.

Step 2. Generate comments

The Generate screen shows the selected routine’s name and rung count, plus optional Select rung range (so you can comment a subset of rungs instead of the whole routine).

Two buttons:

• Generate Comments. The deterministic / standard pass. Faster, cheaper.
• Deep Review. An AI-enhanced second pass with broader program context. Slower; better on complex or cryptic code. Better for a holistic and higher-level understanding of the code in front of it.

Pick the one that fits the routine. For straightforward, well-named code, the standard pass is usually enough. For inherited code with cryptic tag names, Deep Review produces better comments because it has more context to work with.

You can also start with Generate Comments, review what you get, and click Deep Review from the review screen if the standard output isn’t good enough. The page keeps your selection so the second pass is one click.

Step 3. Review per-rung

The review view shows every rung in the routine (or the selected range) with the AI’s suggested comment next to the existing one. Each rung has three actions (Accept, Edit, or Reject), and the suggestions stack up as you work through them.

The header bar surfaces:

• The routine name and an AI-Enhanced badge if Deep Review was used.
• Save Config. Stores your in-progress decisions so you can return later without re-running the generation.
• Deep Review. Runs the enhanced pass (only visible if you started with the standard pass).
• Apply & Download. Produces the commented L5X with everything you’ve accepted.

If the generation truncated because of a tier limit, a blue banner above the review explains how many rungs were processed and links to the pricing page. The truncation cutoff scales with your tier.

Step 4. Apply and download

Click Apply & Download. Comment Helper builds an updated L5X with your accepted comments embedded on the right rungs and triggers a download. The success view confirms how many comments were applied and offers Download Again or Start Over.

Import the commented L5X back into Studio 5000

1. Right-click the program the routine came from in your Studio 5000 project.
2. Click Import then Import Routine.
3. Select the commented L5X.
4. Set the routine name to match the original so the import replaces rather than duplicates.
5. Click OK.
6. Review the imported routine before deployment. Spot-check the comments on a handful of rungs.

Commit the project to source control after import. The commented version becomes the new baseline.

Common pitfalls

FAQ

Can I comment multiple routines at once?

Not in a single run; Comment Helper operates on one routine per pass. For a multi-routine program, run the upload once, pick the first routine, generate / review / download, then click Start Over (or use the routine picker again) to pick the next one. Saved sessions are per-routine.

How long does it take?

The standard pass on a short routine takes a few seconds. Deep Review on a 200-rung routine takes a minute or two. Review pace is up to you; expect 30 to 60 minutes for a thorough read on a 200-rung routine if you read every suggestion.

What about Structured Text or Function Block routines?

Comment Helper is optimized for ladder logic. The upload parser still surfaces ST and FB routines so you can see them, but the AI’s suggestions are weakest there.

Can I use Comment Helper on a routine that already has comments?

Yes. The routine picker shows uncommented vs commented rung counts so you know which routines need the most work. During review the AI’s suggestion shows next to any existing comment; you decide per-rung whether to keep, overwrite, or rewrite.

Does Comment Helper modify logic?

No. Only the comment text on each rung. The instruction sequence, tag references, and rung order are preserved exactly.

What's the difference between Generate Comments and Deep Review?

Standard generates comments from the rung’s instructions and the routine’s name; fast and cheap. Deep Review runs a two-pass pipeline over the same routine: a discovery pass that builds an understanding of what the routine is doing, then a comment pass that uses that context per rung. Slower, better on inherited or cryptic code.

Related

• Code Analyzer. Run before Comment Helper to identify which routines have real structural issues. Document the surrounding code with Comment Helper after fixing them.