Code snippet – code commenting
by Mat Fergusson, Simon Buxton
Mastering Microsoft Dynamics AX 2012 R3 Programming
- Mastering Microsoft Dynamics AX 2012 R3 Programming
- Table of Contents
- Mastering Microsoft Dynamics AX 2012 R3 Programming
- Credits
- About the Authors
- About the Reviewers
- www.PacktPub.com
- Preface
- 1. Preparing Our Solution
- The technical architecture of a solution
- Minimizing the footprint of changes
- Selecting the appropriate layer for our solution
- Configuring source control
- Creating the models
- Creating a label file
- Creating a project
- Setting up the default project and model
- Designing the technical solution
- Designing test plans
- Summary
- 2. Creating Data Structures
- 3. Creating the User Interface
- 4. Creating Business Logic and Hooking into Core AX
- Moving table validation and logic into a class
- Adding navigation
- Number sequences
- Hooking into standard AX logic using event handling
- Summary
- 5. Adding Business Intelligence
- 6. Extending the Solution
- Adding secondary list pages
- Using menu items to change the vehicle status
- Adding a drop dialog to change vehicle group
- Exposing the vehicle group logic as a custom web service
- Summary
- 7. Designing Your Security Model
- 8. Customizing Standard AX
- Key goals when customizing standard or third-party code
- How to determine where to make the change
- Adding fields to tables
- Integrating a custom module with standard AX
- Using an extension table for additional fields
- Changing the behavior of a class
- Extending a framework – vendor electronic payments
- Summary
- 9. Advanced Features and Frameworks
- Adding custom filters to list pages
- Advanced methods of adding ranges to list pages
- Using the SysOperation framework
- Using the SysOperation framework execution modes
- Customizing the user interface displayed by the SysOperation framework
- Tracking progress of scheduled tasks
- Understanding the global address book
- Accessing the financial dimension framework
- Summary
- 10. Advanced Development Techniques
- 11. Unit and Performance Testing
- A. Efficient Design and Development with Microsoft Dynamics AX
- B. Using Version Control
- C. Code Editor Scripts
- Index
To simplify and bring consistency to code commenting, we use an editor script to add comments. This is a simplified version of what we use internally.
We need to edit a standard class to do this, and since some scripts are better when split into methods, we'll create a new class in order to minimize the number of changes.
Create a new class, ConXppCodeSnippets, and add the following method:
public static NotesLine commentText()
{
return strFmt("%1 modification by %4 on %5: ", "Con",
currentAOLayer(), curUserId(),
date2str(systemDateGet(), 321,2,4,2,4,4));
}We can also use this in other methods and extend it, so that we can get data from a parameter table. In the EditorScripts class, create the following method:
public void contoso_comment(Editor editor)
{
int currentLine = editor.currentLineNo();
int currentCol = editor.columnNo();
str prefix = "";
editor.unmark();
if(currentCol == 0)
{
currentCol = 4;
prefix = strRep(' ', 4);
}
editor.insertLines(prefix+'// ' +
ConXppCodeSnippets::commentText() + '
'),
editor.gotoLine(currentLine+2);
editor.insertString(strRep(' ', currentCol));
}Restart AX, and look at the Scripts menu. It has created the Contoso submenu, with Comment as an option.
-
No Comment
..................Content has been hidden....................
You can't read the all page of ebook, please click here login for view all page.