istanzia o inizializza quando si usa una nuova classe?

1

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 double volt {get; set;}
    public double curr {get; set:}
} 

Da qualche altra parte nello stesso spazio dei nomi

public class AnotherTest
{
    TestClass test;

    public AnotherTest(TestClass test)
    {
       this.test = new TestClass(); //how to comment this?
    }
}
    
posta Sean87 31.10.2011 - 09:10
fonte

1 risposta

9

Non hai bisogno di commenti nell'esempio dato. Hai bisogno di nomi di variabili migliori.

Utilizza le seguenti regole per giudicare il valore di un commento:

  1. Commento sull'implementazione specifica di un pezzo di logica o regola aziendale o registro di modifica programma o modifica di funzionalità

  2. Non commentare mai la sintassi del linguaggio all'interno del codice (come nel tuo caso) - Lo sviluppatore dovrebbe conoscere la sintassi

  3. Commenta una scelta specifica di un approccio informatico come l'utilizzo di Instr anziché di Regex che potrebbe comportare un aumento delle prestazioni

  4. Aggiungi commenti per descrivere l'utilizzo specifico di variabili e metodi per evitare nomi lunghi non necessari o per chiarire rapidamente lo scopo del lettore.

  5. Troppi commenti sono inutili e dannosi a volte, soprattutto se non vengono mantenuti.

  6. Il codice non è l'unico posto per i commenti.

  7. Se stai lavorando su un progetto, hai delle linee guida.

risposta data 31.10.2011 - 09:20
fonte

Leggi altre domande sui tag