Domande con tag 'comments'

domande con tag
1
risposta

Esiste un particolare standard di codifica con commenti tra nome funzione e corpo?

Mi sto integrando con un'API di spedizione integrata in php. Hanno uno strano standard di codifica in cui i commenti sono tra il nome della funzione e la prima parentesi graffa .. che - soggettivamente - rende il codice veramente difficile da...
posta 07.10.2014 - 01:10
1
risposta

I commenti nella parte superiore di un file sorgente sono una cattiva idea? [duplicare]

Uso Xcode per modificare i miei file sorgente, e in genere un file sarà simile a questo // // Queue.swift // SomeCompany // // Created by Someone (Job Title) on 26/06/2017. // Copyright © 2017 SomeCompany. All rights reserved. // /// A...
posta 30.08.2017 - 11:12
1
risposta

Rendere esplicito il flusso di controllo attraverso la stampa anziché utilizzare i commenti?

Avrei il parere e le buone pratiche nella programmazione di script sull'uso delle istruzioni di stampa per materializzare il flusso di controllo (di solito uso un segno di ancoraggio, quindi il nome della funzione appena inserita e infine il num...
posta 10.08.2017 - 14:53
1
risposta

Devo eseguire il backup dei file di implementazione in una mia libreria, oltre alle intestazioni?

Sono in procinto di scrivere commenti Doxygen per questa mia biblioteca; è una libreria di intestazione, in gran parte C ++, ma ha un codice che viene collegato anziché incluso. Per quel codice, che ha intestazioni .h / .hpp - dovrei aggiunge...
posta 28.03.2017 - 21:51
2
risposte

È una cattiva pratica citare URL come riferimenti nei commenti? [chiuso]

A volte penso sia utile citare una pagina web ( per esempio domande Stack Overflow) per giustificare e spiegare una parte di codice. È considerata una cattiva pratica?     
posta 23.03.2014 - 15:27
1
risposta

Metriche: commenti vs API documentata

Mi è stato chiesto di eseguire alcune metriche del codice per valutare la qualità del codice. Una delle metriche è stata vagamente specificata come "commenti". Ho eseguito Sonar sul mio codice, e mentre ho ottenuto il 10% sulla metrica "comme...
posta 28.06.2011 - 19:07
2
risposte

Spaziatura aggiuntiva prima di un commento incorporato [chiuso]

All'inizio della mia carriera mi è stato consigliato di aggiungere ulteriore spaziatura tra il codice sorgente e un commento in linea, in questo modo: de_cologne = (i == 4711 # 1 and j == 1799) # 2 Nota i due spazi. Presu...
posta 13.09.2017 - 18:31
1
risposta

I commenti di riepilogo dei file sono un buon modo per sapere cosa fa ciascun file?

Voglio sapere se includere un commento di riepilogo del file all'inizio di ogni file è un buon modo per sapere cosa fa ogni file o c'è un modo migliore.     
posta 02.10.2018 - 22:14
1
risposta

Esistono standard per separare diversi tipi di commenti (esplicativi, debug, cose da fare, ecc.)?

Per un po 'di tempo ho preso l'abitudine di differenziare diversi tipi di commenti nel mio codice. //this is an explanatory comment //!this line was commented out for debug purposes, DO NOT SHIP WITH THIS COMMENT IN PLACE //?this code was te...
posta 21.02.2014 - 22:05
1
risposta

Qualcuno usa ancora TODO per scrivere il codice più tardi? [chiuso]

Dichiarazione Spesso mi trovo ancora a scrivere la seguente dichiarazione su tutto il mio codice: // TODO: (the work that needs done) Lo faccio per segnalare che ho bisogno di tornare e fare qualcosa più tardi. Succede spesso qua...
posta 26.04.2016 - 14:43