documentation

6calore

3risposta

Ho bisogno di documentare un bel po 'di codice JavaScript e jQuery. Sono interessato ai diagrammi, piuttosto che alla documentazione scritta. Mi chiedo se esiste una sorta di standard per la modellazi

21calore

5risposta

Esiste uno stile standard per la documentazione in PHP?

Sono nuovo allo sviluppo di PHP e mi chiedo se la community abbia delle linee guida per la documentazione inline del codice usando i commenti. Mi piacerebbe qualcosa di simile a Python PEP 257, ma mi

47calore

6risposta

Il modo migliore per documentare oggetti anonimi e funzioni con jsdoc

Modifica: Questa è tecnicamente una domanda in 2 parti. Ho scelto la risposta migliore che copre la domanda in generale e collegata alla risposta che gestisce la domanda specifica. Qual è il modo migl

28calore

5risposta

C++: dove scrivere la documentazione del codice: in .cpp o in file .hpp?

Dove è usuale scrivere la documentazione in codice di classi e metodi? Si scrivono tali blocchi di documenti sopra la classe/metodo corrispondente nel file di intestazione (.hpp) o nel file di origine

33calore

4risposta

Dov'è la documentazione di JetBrains IntelliJ openapi?

Ho cercato il sito Web di Google e JetBrains, ma non riesco a trovare documenti per i pacchetti com.intellij. Qualsiasi IDEA (:-))?

6calore

5risposta

Documentazione getter e setter

Per getter/setter semplici, come quello seguente, qual è il modo migliore per documentarlo? public float getPrice() { return price; } Sono abbastanza rigorosi su standard di codifica, quindi

6calore

4risposta

Come si fa la documentazione nell'obiettivo C?

Qualcuno potrebbe condividere i modi per fare la documentazione nell'obiettivo C? C'è un modo standard come è in Java?

8calore

3risposta

Quali strumenti posso usare per documentare i testicoli?

Qualcuno può consigliare uno strumento facile da usare, flessibile e leggero per documentare i casi di test? Devo testare una GUI e ci sono molti casi di test, che sono attualmente conservati in un fo

8calore

3risposta

Documentazione di database relazionali (tabelle, viste, funzioni, trigger)

Sto cercando di migliorare la gestione della conoscenza delle strutture MySQL disponibili su un progetto. Per struttura, intendo tabelle, viste, funzioni, procedure, trigger. Tutte queste strutture ve

6calore

2risposta

XSD per la documentazione XML generata per C#?

Qualcuno sa se c'è un file XSD da qualche parte che può essere utilizzato per convalidare la documentazione XML che viene generata quando si compila un progetto C# con l'opzione/doc? Voglio modificare