Capitalizzazione dei metodi personalizzati in un progetto basato su SDK [chiuso]

Question

Capitalizzazione dei metodi personalizzati in un progetto basato su SDK [chiuso]

#1 da (3 voti)
#2 da (3 voti)

0

Nei progetti che richiedono un uso intenso dell'SDK, come lo sviluppo di Android e iOS, voglio che i metodi / funzioni che scrivo siano ovvi e poiché l'intero framework è scritto con nomi di metodi in lettere minuscole, vorrei che i miei metodi inizino con maiuscolo.

Tuttavia questo è un buon approccio se ci saranno altri programmatori inclusi nel progetto? Questo creerebbe un sovraccarico mentale & confusione o semplificherebbe davvero le cose?

{
    didReceiveMemoryWarning(); // obviously a framework method
    MemoryWarning(); // obviously custom method

    item.height(); // obviously a framework method
    item.SeventhDimensionOfItem(); // obviously custom extension
}

coding-standards conventions

posta Esqarrouth 02.01.2015 - 10:07

fonte

2 risposte

Leggi altre domande sui tag coding-standards conventions

Quale schema uso e come posso implementarlo per un metodo che verrà gestito in più modi Qual è una definizione formale per un passo dell'algoritmo?

score 3 · Answer 1

A meno che non si abbia una ragione convincente, in genere si consiglia di attenersi alle convenzioni del codice del linguaggio di programmazione che si sta utilizzando. La modifica delle convenzioni di denominazione dei metodi potrebbe far pensare agli sviluppatori che potrebbero consumare alcuni servizi esterni o forse superare altri limiti.

Se vuoi far notare che il metodo non è disponibile nell'SDK predefinito, allora penso che il posto migliore per segnalarlo sia includerlo nella documentazione del metodo. La maggior parte degli IDE oggigiorno è in grado di mostrare documentazione come JavaDoc e NDoc attraverso la loro capacità intellisense.

score 3 · Answer 2

Attenersi alle convenzioni di denominazione specifiche per la piattaforma che stai utilizzando.

È abbastanza facile per qualsiasi sviluppatore con un IDE vedere se un metodo o una classe proviene dall'SDK, da una libreria di terze parti o dal proprio codice. Solitamente è facile come passare il mouse sul codice e vedere un nome qualificato.

Inoltre, non penso che sia davvero così importante per uno sviluppatore dire la differenza tra codice framework e codice personalizzato. Finché conoscono l'API e cosa dovrebbe fare il metodo, non dovrebbe davvero importare. Preferisco di gran lunga che sia ovvio (e indicato dalle convenzioni sui nomi) quale parte di codice menziona un nome di una classe, un metodo, invoca un costruttore, accede a un campo oa una classe nidificata statica.

Queste convenzioni saranno diverse tra le lingue ma, a mio parere, dovresti mantenere il tuo codice coerente con esse.

Would this create mental overhead & confusion or would it really simplify things?

Certamente lo percepirei come fonte di confusione.