# Writing Xml Doc Comments

> >

- **Type:** Skill
- **Install:** `agentstack add skill-nice3point-revit-skills-writing-xml-doc-comments`
- **Verified:** Yes — security-reviewed for prompt injection and unsafe behavior
- **Seller:** [Nice3point](https://agentstack.voostack.com/s/nice3point)
- **Installs:** 0
- **Category:** [Agent Skills](https://agentstack.voostack.com/c/agent-skills)
- **Latest version:** 0.1.0
- **License:** MIT
- **Upstream author:** [Nice3point](https://github.com/Nice3point)
- **Source:** https://github.com/Nice3point/revit-skills/tree/main/plugins/dotnet/skills/writing-xml-doc-comments

## Install

```sh
agentstack add skill-nice3point-revit-skills-writing-xml-doc-comments
```

Requires the [AgentStack CLI](https://agentstack.voostack.com/docs/cli). Works with Claude Code, Cursor, and any MCP-compatible agent.

## About

# Writing XML Doc Comments

Document the contract a caller depends on, not the mechanics a reader can see in the signature.
Every public type and member gets a ``.

## When to use

- Adding or reviewing doc comments on public or externally consumed API surface.
- A member has a null, empty-result, ownership, or edge-case rule a caller must know.

## Rules

- Add a `` to every public type, member, and property.
- State the contract in ``; do not restate the name or parameter list in words.
- Add `` and `` where they carry information beyond the names; state what a null or empty result means in `` or ``.
- Add `` only for a caller-visible constraint, edge case, or ownership rule.
- Reference code symbols with `` so renames stay linked.
- Describe observable behavior, not the current implementation.

## Examples

```csharp
/// 
///     Opens the file at  and returns a reader positioned at its start.
/// 
/// Absolute path to an existing file.
/// The opened reader; never null.
/// The caller owns the returned reader and must dispose it.
public StreamReader OpenReader(string path)
```

```csharp
/// 
///     Returns the cached value for , or null when the key is absent.
/// 
public CacheEntry? Find(string key)
```

## Validation

- [ ] Every public type and member has a ``.
- [ ] Summaries state the contract, not a restatement of the signature.
- [ ] Ownership rules appear in ``; null and empty-result meaning appears in the summary or returns.
- [ ] Symbol references use ``.

## Common Pitfalls

| Pitfall                                             | Correct approach                                                          |
|-----------------------------------------------------|---------------------------------------------------------------------------|
| `Gets the name.` on `GetName()`  | State what the name is and any constraint, or omit the empty restatement. |
| Documenting the implementation ("loops over items") | Describe the observable contract.                                         |
| Ownership rules left implicit                       | State them in ``.                                                |
| Hardcoding a type name in prose                     | Use ``.                                             |

## Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

- **Author:** [Nice3point](https://github.com/Nice3point)
- **Source:** [Nice3point/revit-skills](https://github.com/Nice3point/revit-skills)
- **License:** MIT

Install and usage instructions live in the source repository linked above.

## Pricing

- **Free** — Free

## Security capabilities

Automated source analysis of v0.1.0 — what this tool can access:

- **Network access:** no
- **Filesystem access:** no
- **Shell / process execution:** no
- **Environment & secrets:** no
- **Dynamic code execution:** no

*"Yes" means the capability is present in the source — more access means more to trust, not that it is unsafe.*


## Versions

- **0.1.0** — security scan: passed — Imported from the upstream source.

## Links

- Listing page: https://agentstack.voostack.com/l/skill-nice3point-revit-skills-writing-xml-doc-comments
- Seller: https://agentstack.voostack.com/s/nice3point
- Browse the marketplace: https://agentstack.voostack.com/browse

---
Listed on AgentStack — the marketplace for AI agent skills and MCP servers. Every listing is security-reviewed. Creators keep 70%.