Add option for auto code comment

[avroguha]

Add JSDoc Comment Generation Feature

Description

Adding automated JSDoc comment generation functionality to the Monaco editor for JavaScript files in SN Utils. This feature helps developers maintain consistent documentation standards by automatically generating JSDoc comments for functions.

Why

• Improves code documentation consistency
• Speeds up the documentation process
• Helps maintain ServiceNow best practices for code documentation
• Useful for both client and server-side scripts in ServiceNow

Features

Core Functionality

• Generates JSDoc comments for functions with a keyboard shortcut (Ctrl+Alt+J / Cmd+Alt+J)
• Available through context menu ("Add JSDoc Comment")
• Configurable via snusettings (enablejsdoc flag)

Supported Function Types

• Traditional function declarations (function name())
• Arrow functions (const name = () =>)
• Async functions
• ServiceNow object method style (method: function())
• Class methods

Smart Comment Generation

• Automatically detects function parameters
• Adds @private tag for underscore-prefixed functions
• Preserves existing JSDoc comments
• Maintains proper indentation
• Adds placeholders for parameter and return value descriptions

Implementation Details

• Added to Monaco editor integration
• Only enabled for JavaScript files
• No changes to existing functionality
• Follows ServiceNow documentation standards

Status

• ✅ Feature Development Complete

  • JSDoc comment generation functionality implemented
  • Code documented with JSDoc comments
  • Feature configurable via snusettings (enablejsdoc)
  • Keyboard shortcuts implemented (Ctrl+Alt+J / Cmd+Alt+J)
  • Context menu integration added

• ✅ Testing Complete

  • Manual test cases documented and executed
  • Tested with various function types:
    • Standard functions
    • Arrow functions
    • Async functions
    • ServiceNow object methods
    • Private functions (underscore prefix)
  • Verified existing comment preservation
  • Tested parameter detection and formatting
  • Tested in both light and dark themes

• 👉 Awaiting Review and Approval

  • Need project owner's review before submitting PR
  • Ready for integration review
  • No changes to existing functionality
  • Follows project's code style and standards