QQ on ApexDoc and JSDoc

Issue #2062 resolved
Chris Tufts created an issue

GM Scott,

Question here as I think you have told me in the past at some point.

Can I edit the default ApexDoc and/or JSDoc somewhere in settings, google and brute force has failed me at the moment…

I just was to add a few things that aren’t there by default (namely @description for both and @returns for JSDoc)

yes I know returns doesn’t actually do anything in JS but es-lint can yell at you if you’re not keeping consistent return types which as I get older the more and more I understand why everyone hates JS so much for not being typed… lol

thanks

Comments (2)

  1. Scott Wells repo owner

    I'm not entirely sure if this is what you're looking for, but you can configure ApexDoc under Settings / Preferences > Editor > Code Style > Apex > ApexDoc. Make sure you're on the latest version because I added some significant enhancements there just a few builds back:

    https://illuminatedcloud.blogspot.com/2022/02/2209-release-notes.html

    There doesn't seem to be anything similar for JSDoc/ESDoc unfortunately, but in case it helps, here's JetBrains' documentation on their JSDoc integration:

    https://www.jetbrains.com/help/webstorm/creating-jsdoc-comments.html

    Hope that helps!

  2. Scott Wells repo owner

    Resolving as answered but don't hesitate to ask additional questions here. No need to reopen as I'll respond here even if resolved.

  3. Log in to comment