documentationjs / documentationjs/documentation

private static class field naming-issue when using Object.freeze()

Offen
#1,355 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
JavaScript
Sterne
5.8k
Forks
481
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

### non-private field :+1:
```js
/**
* Holding builtin toHtml variants.
* @property {toHtml} classic - designed for {@link TaxiOptions}.data type of string[].
*/
static ToHtml = Object.freeze({
classic: (entry) => {
return `


${entry}
`;
},
});
```
returns this documentation: (within the class scope)
![image](https://user-images.githubusercontent.com/56562982/106604474-fa442300-655f-11eb-99c6-c52a1bc45093.png)

### private field 👎🏼
where as this code (which is also within said class scope)
```js
/**
*
* Default TaxiOptions, to be used incase of none given.
* @property {*} data - ["Volkwagen", "Mercedes", "Daimler"]
* @property {query} query - {@link #taxiquery}
*/
static #TaxiOptionsDefaults = Object.freeze({
data: ["Volkwagen", "Mercedes", "Daimler"],
query: Taxi.Query.strict,
toHtml: Taxi.ToHtml.classic,
minChar: 1,
showWarnings: true,
});
```
Turns up below the class, as the following.
![image](https://user-images.githubusercontent.com/56562982/106604611-295a9480-6560-11eb-9202-72eeedcd146b.png)

### I tried:
giving a `* @name ANYTHING_BUT_FREEZE` to the latter documentation, which didnt work.
and that is about it, i really like documentation.js but I don't know how to fix it apart from making it public which I'm not a fan of, since they needn't be public.

* What version of documentation.js are you using?: 13.1.1
* How are you running documentation.js (on the CLI, Node.js API, Grunt, other?): via npm(node.js) global install without sudo(not that that would make a difference)

any help would be appreciated, also if it means I need to change my code to something else, as long as it's not going to be public :D

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Reproduziere das Problem mit den öffentlichen und privaten Static-Field-Beispielen aus dem Bericht unter Verwendung von documentation.js 13.1.1. Verfolge, wie documentation.js private Static Fields parst und benennt, und vergleiche anschließend die generierte Platzierung mit der erwarteten Dokumentation im Klassen-Scope. Als abgeschlossen gilt die Aufgabe, wenn das private Feld unter seiner Klasse dokumentiert wird, ohne es public zu machen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
documentation
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.