How to handle BP Warning BP Rule: BPXmlDocNoHelpfulInformation: No helpful information is provided

(0) Share

Report

Posted on by Ken Manhattan

552

Hi all,

In my classes, I added a comment for method description. Something like :

   /// <summary>
    /// part of payment and settlement process
    /// </summary>
    /// <param name = /_receiptId/></param>
    /// <returns></returns>
    public boolean IsCompanyReceipt(RetailReceiptId    _receiptId)

{

}

But it still give me BP warning said it is not helpful.

BP Rule: [BPXmlDocNoHelpfulInformation]:BPXmlDocNoHelpfulInformation: No helpful information is provided

What should I write to make F&O consider it is helpful ? Because I think it is help enough for us.

Thanks

I have the same question (0)

All responses (2)

Answers (1)

Suggested answer

Martin Dráb 237,740 Most Valuable Professional on at

Like (0)

Report

You forgot to document the purpose of the parameter and the return value. Using empty strings instead of documentation indeed isn't helpful.

Was this reply helpful? Yes No
Verified answer

GirishS 27,827 Moderator on at

Like (1)

Report

Hi Ken,

Your method has return type Boolean. So, you must specify what method should return.

Like "True if it's a company receipt otherwise false".

Thanks,

Girish S.

Was this reply helpful? Yes No