StackExchange/dnscontrol
1
1
Fork 0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2024-11-10 09:12:47 +08:00
Code Issues Projects Releases Packages Wiki Activity

DOCUMENTATION: Add JSDoc info to style guide (#2403)

Browse source 
Co-authored-by: Jeffrey Cafferata <jeffrey@jcid.nl>
This commit is contained in:
Tom Limoncelli 2023-05-30 15:06:57 -04:00 committed by GitHub
parent f5a9f8b6d0
commit 83a7f06718
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
documentation/styleguide-code.md
View file

@ -48,6 +48,16 @@ These are the filenames to use:
* `providers/foo/listzones.go` -- Code for listing and creating DNS zones and domains
* `providers/foo/dnssec.go` -- Code for DNSSEC support
# JavaScript annotations
Functions in `pkg/js/helpers.js` should be annotated using the
[JSDoc](https://jsdoc.app/tags-param.html) `@` notation. These are used to
generate autocomplete instructions for your IDE.
* Add `@param {type} foo` for a parameter named `foo` that is of type `type`.
* Example: `@param {string} foo Description of the parameter`
* Add `@deprecated` if the function is deprecated.
# Don't conditionally add/remove trailing dots