The new version of XIDE will also include a new update for the wxEditorKit plugin. This update handles the automatic triple slash comments aka documentation comments. With this new functionality, writing documentation comments becomes faster and easier. Here's how it works:
1. When you type /// at the beginning of a line and press Enter, the plugin will automatically insert a new line starting with /// at the correct position (this occurs only if you have some comment afte the triple slashes)
2. The cursor will be placed right after the triple slashes, so you can immediately continue typing your comment.
This feature ensures consistent formatting for your documentarion and saves time when writing XML-style comments for you code.
NOTE: you can complement this feature by adding this template in your XIDE\Config\Template.cfg file:
Code: Select all
metdoc,/// <summary>\r/// Describe what the method does here.\r/// </summary>\r/// <param name="parameterName">Describe the purpose of the parameter.</param>\r/// <returns>\r/// Describe what the method returns here.\r/// </returns>\r/// <exception cref="ExceptionType">\r/// Describe when this exception is thrown.\r/// </exception>
Happy new year to every body!