![]() If you use Doxygen, you can generate your documentation directly from the Command Palette. If a cursor is in a comment block (without selection), all descriptions of this comment will be translated. To translate selections, go to the Command Palette ( Ctrl+ Shift+ P), then select DoxyDoxygen: Translate or DoxyDoxygen: Translate To to translate them. If you are behind a proxy, don't forget to configure it before using those features. You can Fold / Unfold comments blocks from the Command Palette or using Sublime Text standard shortcuts. You can move from a tag to the referenced page or section using the goto_definition command (press F12 using Sublime Text default key bindings) Fold / Unfold comments To ease navigation, press End ( Super+ Right on OS X) on end-of-line to go to the next column. Navigate in documentation Move to the right column If activated, you can press Shift+ Enter to stop continuation. The behavior is optional (see parameter continuation_on_last_comment). On single line comment, comment continuation may appear as strange on the last line comment ( ///). Only commands matching your configured doc-styles are suggested.įor example, to get the list of available commands, press Then, press Ctrl+ Space to display the completion list.Ĭtrl+ Space is optional, but Sublime Text defaults settings deactivate completion in comment (see auto_complete_selector settings).Īs you can see on previous example, pressing Enter consecutively automatically continues the comment. Extend a documentation block Auto-completionĭoxyDoxygen allows auto-completion. You can also find more flexible commands in the Command Palette. To switch between your preferred comment styles, press Shift+ Alt+ Q (or Super+ Shift+ Alt+ Q on OS X). ** * Error code: E_OK E_ACCESS_DENIED E_INTERNAL */ Switch between comment styles A valid list item is a line that start with -#, -, + or *. On update, spaces before an item are kept. As DoxyDoxygen knows the Doxygen commands, no invalid line break will be inserted.Įven better, with default settings, Alt+ Q also reexamine the documented object and detects missing, renamed or moved parameters:ĭoxyDoxygen preserves list with hierarchy. To update a comment, press Alt+ Q (or Super+ Alt+ Q on OS X). Update / wrap an existing documentation block If a function has a template parameter, a property is automatically added:Īnd, of course, classes (with template or not) are also supported. Types are automatically deduced from the code:Įven difficult to analyze programming languages are properly supported: A documentation block is written for you. To be more efficient, you may also press Alt+ Q (or Super+ Alt+ Q on OS X) after the function definition. There are no keyboard shortcuts to memorize. ![]() The corresponding documentation will automatically be inserted. Start a documentation block (usually /**) before a declaration, then press Enter. no matter your preferred layout for tags…ĭocumentation is generated… Descriptions are written in your native language…Īnd, reading this manual you will discover even more features like on demand translation… Usage Create a documentation block.no matter your comment style : /**, ///….no matter your documentation generator : ApiDoc, AsDoc, Doxygen, Drupal Api Module, Google Closure, JavaDoc, JsDoc, PhpDocumentor, SassDoc, Sphinx, XmlDoc, YuiDoc….Press Alt+ Q (or /** + Enter), code is parsed and a skeleton documentation is written for youĭoxyDoxygen can be easily configured to suit your needs.DoxyDoxygen is a plug-in for Sublime Text that aims to save a lot of time and efforts when creating and updating documentation comments in source code.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |