Domande con tag 'comments'

domande con tag
4
risposte

Collegamento nei commenti di codice (ad altri ancoraggi / commenti unici)

Come consiglieresti di creare "ancore" nei commenti di codice, in modo che durante la manutenzione, gli sviluppatori possano facilmente fare riferimenti incrociati ad altri commenti di codice. Mi rendo conto che il software dovrebbe essere st...
posta 15.05.2012 - 12:23
1
risposta

Descrizione del flusso del programma JS in @fileoverview

Devo modificare il codice JavaScript di altre persone. Il codice in genere carica alcuni dati da un'API Web, genera una tabella, la inserisce nella pagina HTML e allega alcuni gestori di eventi. A causa della natura asincrona, il flusso del p...
posta 02.08.2017 - 06:20
7
risposte

Commenti a riga singola per più righe di codice rientrate [chiuso]

Dopo molti anni di codifica, tentativi di vari stili di programmazione, eliminazione di cose illeggibili o poco pratiche, non riesco ancora a capire una cosa: qual è il modo migliore per commentare a riga singola più righe di codice rientrato....
posta 11.05.2011 - 16:41
2
risposte

È necessario commentare i parametri ovvi? [duplicare]

La maggior parte delle volte, quando commento un metodo, seguirò questa struttura. /** * Short description of what the method does * * @param {Type} name. Description of the variable. * * @return {Type}. What the return is. */ Ora s...
posta 18.09.2014 - 14:20
3
risposte

Devo marcare cosa significano i blocchi negli attributi data- *?

Oggi stavo scrivendo una pagina web con un commento dopo l'inizio di ogni sezione importante . Invece di usare un commento, che viene fornito con la sintassi <!-- --> ingombrante, potrei invece inserirlo in un attributo data-*...
posta 22.09.2014 - 22:21
2
risposte

Qual è la differenza (se esiste) tra le dichiarazioni ei commenti REM?

Recentemente ho scoperto il termine dichiarazione REM e mi chiedevo, è sinonimo di commento?     
posta 10.03.2017 - 09:09
1
risposta

istanzia o inizializza quando si usa una nuova classe?

la mia domanda è piuttosto una questione di lingua inglese. Per commentare correttamente il mio codice, voglio sapere quando si fa ad esempio il seguente codice, quale commento si può scrivere per questo? public class TestClass { public do...
posta 31.10.2011 - 09:10
2
risposte

@Deprecated dalla versione x.y in JavaDoc

Questa domanda & le sue risposte sono utili ma non sufficienti per il mio problema. La mia domanda è se voglio aggiungere un javadoc come @Deprecated A partire dalla versione x.y, sostituito da {@link SomeClass} nel javadoc del mio fi...
posta 07.02.2013 - 05:56
3
risposte

Commentando le strategie in C # e asp.net web api

Ho lavorato a un progetto ASP.NET Web Api 2 come esercizio di apprendimento e mi chiedevo quale fosse la norma riguardante i commenti. Uso il modello di repository / servizio, e tutto è molto disaccoppiato, il che si traduce nell'avere un gra...
posta 05.07.2014 - 00:28
1
risposta

A cosa serve ##?

Ho esaminato altre domande al riguardo e il consenso generale sembra essere che ## è usato per commentare il codice. Tuttavia, nell'editor interattivo per Python, il prefisso di una riga con ## sembra creare una sorta di intestazione d...
posta 24.03.2015 - 01:00