How to force input summary comment C# project

Question

1.00/5 (1 vote)

See more:

I want to create a rule that requires developer to enter a summary comment

HTML

/// <summary>
        /// 
        /// </summary>
        /// <param name="id"></param>
        /// <returns></returns>

What I have tried:

Please tell me any solution for my problem. thanks

Posted 9-Dec-20 15:41pm

Member 13338759

Updated 9-Dec-20 18:46pm

Add a Solution

1 solution

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

BillWoodruff · Answer 1 · 2020-12-09T18:46:00

You are describing adding functionality to (I assume) Visual Studio.

You can force VS to produce warning messages for certain XML comments: [^] by setting project options:

Quote:
StyleCop is a source code analysis tool that provides developers with an effective way to follow C# coding standards. FxCop runs against the compiled binaries as a way to understand and enforce the.NET Framework Guidelines for managed code assemblies.

[^]

StyleCop: [^], [^] . Also, check out: [^]

There are also 3rd. party tools that integrate into Visual Studio that will annotate your code ... on demand ... a few years ago I purchased Atomineer [^] which at that time met my limited needs for a relatively low-cost on-demand annotation.