Comment Layout And Formatting logo

Comment Layout And Formatting

Community
kitchen-engineer42
comment-layout-and-formatting

Apply proper indentation and spacing rules to code comments to enhance readability and maintain code visual structure. Use when writing or formatting comments within code blocks, or when establishing code style guidelines.

Overview

Publisherkitchen-engineer42
Repositorypdf2skills
Skill namecomment-layout-and-formatting
Stars
136
Forks
34
Bundled files
Instructions only
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • Self-contained

    Everything the model needs lives in the instructions — no extra files to sync.

  • Open source

    Published by kitchen-engineer42 on GitHub. Read the source before you install it.

Installation

Install the Comment Layout And Formatting AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
    https://github.com/kitchen-engineer42/pdf2skills/tree/main/skills_samples/Steve%20McConnell%20Code%20Complete%20A%20Practical%20Handbook%20of%20Software%20Construction_output/comment-layout-and-formatting
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.

Use it in TypingMind

Enable Comment Layout And Formatting in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Comment Layout And Formatting on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Comment Layout And Formatting is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

Comment Layout and Formatting

Apply these rules to ensure comments enhance rather than disrupt code readability.

Comment Indentation

When to apply: When writing or formatting code comments (excluding end-of-line comments)

  1. Align comments with the code they describe using the same indentation level
  2. Ensure comments do not obscure the visual indentation structure of the code
  3. Maintain visual hierarchy to help readers understand program logic structure

Rationale: Research (Shneiderman 1980) shows comments that interfere with visual scanning reduce their effectiveness. Good comment style should enhance, not disrupt, visual structure.

Comment Spacing

When to apply: When separating code blocks or emphasizing comments

  1. Place at least one blank line before each comment to separate it from code
  2. Optional: Use blank lines both before and after comments (two total)
    • Pros: Better visual effect, easier to scan
    • Cons: Consumes more display space
  3. Decision is primarily aesthetic unless display space is extremely limited

Core principle: Having a consistent convention is more important than the specific details of the convention.

Result

  • Code logical structure remains clearly visible
  • Comments are visually separated from code
  • Comments align with their corresponding code blocks

Frequently asked questions

What does the Comment Layout And Formatting AI skill do?

Apply proper indentation and spacing rules to code comments to enhance readability and maintain code visual structure. Use when writing or formatting comments within code blocks, or when establishing code style guidelines.

Why use Comment Layout And Formatting on TypingMind?

Because you install it once and use it with any model. Comment Layout And Formatting is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Comment Layout And Formatting in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/kitchen-engineer42/pdf2skills/tree/main/skills_samples/Steve%20McConnell%20Code%20Complete%20A%20Practical%20Handbook%20of%20Software%20Construction_output/comment-layout-and-formatting. TypingMind reads its SKILL.md and installs it as a skill you can enable per chat.

Which AI models can use Comment Layout And Formatting?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Comment Layout And Formatting?

As many as you like. As long as a model supports skills, you can use Comment Layout And Formatting with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Comment Layout And Formatting AI skill free?

It is published on GitHub by kitchen-engineer42. Check the repository for licensing terms. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇