Skip to main content

Notifications

Finance | Project Operations, Human Resources, ...
Answered

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

(0) ShareShare
ReportReport
Posted on by 516
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
 
 
 
  • Verified answer
    GirishS Profile Picture
    GirishS 27,821 Super User 2024 Season 1 on at
    How to handle BP Warning BP Rule: BPXmlDocNoHelpfulInformation: No helpful information is provided
    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.
  • Suggested answer
    Martin Dráb Profile Picture
    Martin Dráb 230,853 Most Valuable Professional on at
    How to handle BP Warning BP Rule: BPXmlDocNoHelpfulInformation: No helpful information is provided
    You forgot to document the purpose of the parameter and the return value. Using empty strings instead of documentation indeed isn't helpful.

Under review

Thank you for your reply! To ensure a great experience for everyone, your content is awaiting approval by our Community Managers. Please check back later.

Helpful resources

Quick Links

Announcing Our 2025 Season 1 Super Users!

A new season of Super Users has arrived, and we are so grateful for the daily…

Vahid Ghafarpour – Community Spotlight

We are excited to recognize Vahid Ghafarpour as our February 2025 Community…

Congratulations to the January Top 10 leaders!

Check out the January community rock stars...

Leaderboard

#1
André Arnaud de Calavon Profile Picture

André Arnaud de Cal... 291,996 Super User 2025 Season 1

#2
Martin Dráb Profile Picture

Martin Dráb 230,853 Most Valuable Professional

#3
nmaenpaa Profile Picture

nmaenpaa 101,156

Leaderboard

Product updates

Dynamics 365 release plans