web
You’re offline. This is a read only version of the page.
close
Skip to main content

Notifications

Announcements

No record found.

Community site session details

Community site session details

Session Id :
Finance | Project Operations, Human Resources, ...
Answered

BPXMLDocNoDocumentation

(0) ShareShare
ReportReport
Posted on by

Hi guys,

Tried to resolve Best Practice issue which I never understood what is that ? and how ?

Severity Code Description Project File Line Suppression State
Warning  BP Rule: [BPXmlDocNoDocumentationComments]:BPXmlDocNoDocumentationComments: No XML documentation headers are provided for 'MyMethod'. 

Tried to follow this, but unfortunately (like always), hard to understand or follow the instruction :https://docs.microsoft.com/en-us/dynamicsax-2012/developer/walkthrough-creating-xml-documentation-in-microsoft-dynamics-ax#to-add-documentation-to-the-method

From point no. 1, already stressed out as where is that Script button, and my mouse should point to where ? ->

Click the Script button to access the Scripts shortcut menu, point to Scripts, point to documentation, and then click HeaderTemplate. XML tags will appear at the top of the code editor.

Hope someone can help to explain what is this Doc telling us to do.

Thanks.

I have the same question (0)
  • Verified answer
    Martin Dráb Profile Picture
    237,965 Most Valuable Professional on at

    Type /// just above the method - it should generate basic structure of the documentation comment, where you can describe the purpose of the method, its parameters and its return value.

    Consult XML Documentation page for more details.

  • Community Member Profile Picture
    on at

    Thanks.

    Wish could be this simple explanation  :)

  • Community Member Profile Picture
    on at

    soy nuevo en esto pero entiendo que Agregando /// se mostrara una estructura de comentarios como la siguiente

    para una clase 

    /// <summary>
    ///        descripcion del la clase
    /// </summary>

    para metodo

    /// <summary>
    /// descipción el metodo
    /// </summary>
    /// <param name = "sales_Line"> descripcion de los parametros </param>
    /// <returns> que retorna el metodo  </returns>

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

Responsible AI policies

As AI tools become more common, we’re introducing a Responsible AI Use…

Neeraj Kumar – Community Spotlight

We are honored to recognize Neeraj Kumar as our Community Spotlight honoree for…

Leaderboard > Finance | Project Operations, Human Resources, AX, GP, SL

#1
Martin Dráb Profile Picture

Martin Dráb 551 Most Valuable Professional

#2
André Arnaud de Calavon Profile Picture

André Arnaud de Cal... 450 Super User 2025 Season 2

#3
BillurSamdancioglu Profile Picture

BillurSamdancioglu 278 Most Valuable Professional

Last 30 days Overall leaderboard

Product updates

Dynamics 365 release plans