JSDoc and Documentation.js weird $0. output
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 35/100
- Tipo di issue
- Bug
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- javascript
- Ambito
- documentation
Direzione di ricerca
Inizia riproducendo l'output di ajax.js con documentation build ajax.js -f html -o docs, concentrandoti sui parametri del costruttore destrutturati e sulle relative voci JSDoc config.*. Confronta l'HTML generato con l'output $0. segnalato e determina se il problema è nel parsing JSDoc o nel rendering HTML di Documentation.js; il lavoro è completato quando le proprietà vengono visualizzate con i nomi e le descrizioni previsti.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
I'm currently writing the documentation for my codebase, but I'm getting weird output when trying to unpack an Object in JSDoc to describe its properties.
/**
* Foundational class for sending requests and managing responses.
*/
class AjaxRequest {
/**
* Constructs a new instance with the given configuration.
*
* @constructor
* @param {Object} config - The configuration object.
* @param {string} config.endpoint - The endpoint URL for the request.
* @param {string} config.method - The HTTP method to use for the request (e.g., 'GET', 'POST').
* @param {string} config.contentType - The content type of the request (e.g., 'application/json').
* @param {Object} config.payload - The payload to be sent.
*/
constructor({ endpoint, method, contentType, payload }) {
//code here
}
}
This produces
Why do I get $0. ?
Documentation was generated using: documentation build ajax.js -f html -o docs
I am using the latest version of Documentation.js
- Lingua principale
- JavaScript
- Stelle
- 5.8k
- Fork
- 479
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di documentationjs/documentation
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
documentationjs/documentation#1669 ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
documentationjs/documentation#1666 · 2 commenti ·
-
Fix outdated depsAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 35/100
documentationjs/documentation#1646 ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100
documentationjs/documentation#1644 ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 42/100
documentationjs/documentation#1642 · 1 commento ·
Tutte le issue di documentationjs/documentation
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
smansfield635-create/smansfield635-create.github.io#5818 · 4 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
documentation
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
danjdewhurst/story-skills#538 ·
I maintainer di solito rispondono entro 1 giorno
-
good first issue
Difficoltà 1/5 1-3 ore Idoneità per principianti 88/100
anoopcodehack/DevBoard#589 ·
I maintainer di solito rispondono entro 2 giorni
-
Difficoltà 2/5 Meno di un'ora Idoneità per principianti 85/100
capricorn86/happy-dom#2474 ·
I maintainer di solito rispondono entro 2 giorni
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 95/100
vigetlabs/mega-menu-block#30 ·
I maintainer di solito rispondono entro 2 giorni