feat: Add assists for macro documentation comments

[naipaka]

🔗 Related Issues

• None

🙌 What's Done

• Add assists for macro documentation comments

Background

https://altive.slack.com/archives/C072SHBR4DT/p1733300766521879

Since public_member_api_docs is true, you need to include doc comments for constructors as well. Until now, I’ve been writing comments like /// Creates an instance of [Xxx].. However, I felt such comments don’t provide much value when checking them in the reference.

Therefore, I thought it might be a good idea to insert the same doc comment as the class using macros, unless there’s something specific to add to the constructor's comment.

To make this adjustment easier, I’ve created an assist feature with custom_lint!

✍️ What's Not Done

• None

🖼️ Image Differences

Add macro template documentation comment	Add macro documentation comment	Wrap with macro template documentation comment

🤼 Desired Review Method

• Correction Commit
• Pair programming

Note

It is possible that a reviewer's will may cause a method to be implemented that is not selected.

📝 Additional Notes

Pre-launch Checklist

• I have reviewed my own code.
• I have added tests that prove my fix is effective or that my feature works.
• I updated/added relevant documentation (doc comments with ///).

[naipaka]

In the example, using @endtemplate as is would be interpreted as the end of the template, so I’ve enclosed it in [] to avoid this!

[k-nkmr]

Thank you for adding this assist!

[k-nkmr]

Suggested change

	if (!target.intersects(node.sourceRange)) {
	return;
	}
	if (!node.isDocumentation) {
	return;
	}
	if (!target.intersects(node.sourceRange)) {
	return;
	}
	if (node.toSource().contains('{@template') &&
	node.toSource().contains('{@endtemplate}')) {
	return;
	}
	if (!node.isDocumentation) {
	return;
	}

I thought it might be worth considering adding this early return.

[naipaka]

Thank you!
It certainly seems like a good idea. ✍️

Since toSource was an empty string and couldn't be evaluated, I changed it to use tokens for evaluation!
feat: Prevent wrapping of existing macro template documentation comments

      final currentComment = node.tokens.join();
      if (currentComment.contains('{@template') &&
          currentComment.contains('{@endtemplate}')) {
        return;
      }

[riscait]

LGTM! Thanks for new feature🚀