Doc comments

Aperta
  • Qualcosa non va?
#178 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
csharp
Ambito
developer-experience, documentation

Direzione di ricerca

Non viene indicato alcun file, test o punto di ingresso. Inizia esaminando il progetto C# e le impostazioni di build del repository per la generazione dei commenti di documentazione, quindi verifica come il risultato viene utilizzato da Visual Studio o Rider. Il lavoro è completato quando i commenti al codice esistenti compaiono in questi IDE, oppure quando il repository documenta perché ciò non è possibile.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

I notice that the documentation in the code

image

isn't picked up by Visual Studio or Rider

image

which is a shame. Is there anything you need to do at your end to enable the doc-comments to be displayed?
e.g.

image

Lingua principale
C#
Stelle
87
Fork
32
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di HDFGroup/HDF.PInvoke

Tutte le issue di HDFGroup/HDF.PInvoke

Issue simili

Altre issue su C#

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.