Commenting Code AS3 - Non essendo un'API

Naviga le tue risposte
0

Come dovrei commentare un metodo?

Quali sono le migliori pratiche sul codice di commento?

Esempio: 

/* Checks if a color is allowed in a given point
* of the bitmapdata of the current floor
* @param value - color to be checked
* @return boolean - if color is allowed returns true, else, return false
*/

private function isAllowed(value:uint):Boolean {

   //code...

}

È il modo migliore per commentare un metodo?

Ho sentito che c'è l'uso del tag @eeee. Cosa dovrebbe essere su questo tag? Mi chiedo se potrebbe essere qualcosa che ha una relazione con il metodo, giusto?

Grazie.

    
posta Marcelo Noronha 14.04.2012 - 21:05
fonte

2 risposte

0

Il modo migliore per commentare un metodo è seguire lo standard esistente nel progetto in cui stai lavorando.

Nei nuovi progetti in cui hai il controllo, la sintassi che hai sopra va bene.

Per quel particolare metodo, rinominandolo in isColorAllowed () si ovvierebbe alla necessità di qualsiasi intestazione di funzione, presumendo che non ci sia uno standard esistente su tali cose.

    
risposta data 14.04.2012 - 23:06
fonte
0

Un buon codice dovrebbe essere abbastanza descrittivo da non richiedere commenti. Ad esempio il metodo dovrebbe fare solo una cosa e avere un nome che descriva quello scopo.

Anche i parametri passati devono essere opportunamente denominati in modo che i commenti di tipo @param non debbano essere utilizzati.

Il codice perfetto sarebbe privo di commenti e avrebbe letto quasi come l'inglese.

    
risposta data 22.12.2014 - 11:08
fonte

Leggi altre domande sui tag

è consentito rimuovere le informazioni sul copyright da un'API open source gratuita anche se gli viene esplicitamente detto di non farlo? [chiuso] il codice gpl può contenere codice con licenza più restrittiva? (CC BY-NC-ND 3.0)