Ho un'applicazione C # sviluppata con VS 2010 pro. La versione definitiva avrebbe una funzione di diagramma di sequenza.
Dato che creerò "manualmente" il mio diagramma di sequenza, come faccio a gestire nomi di metodo piuttosto lunghi?
object.createPathForCustomerIDblablablabla_click()
Ho appena usato i nomi dei metodi come sono già stati dati? Utilizzare un nome più breve nel diagramma di sequenza?
Vorrei che si adattasse a una pagina A4.
A parte:
Contrariamente alla credenza popolare, i nomi lunghi non sono sempre una cosa negativa.
Usato con moderazione,
possono essere utili.
Per esempio,
se un metodo restituisce un valore booleano che indica che l'avvio dell'applicazione dovrebbe essere interrotto se l'esecuzione fallisce all'avvio dell'applicazione, uno di questi è più chiaro dell'altro:
Alla domanda:
Se i nomi sono troppo lunghi per adattarsi comodamente a un diagramma, considera la possibilità di creare solo nomi brevi nel diagramma e associarli al nome completo del metodo.
Ad esempio: utilizzare createPFCIDbbbbc nel diagramma e includere una pagina che associa il nome breve al nome lungo. Prendi in considerazione di segnalare i nomi brevi; un modo è quello di aggiungere un asterisco nella parte anteriore dei nomi abbreviati. In tal caso, * createPFCIDbbbbc indica che si tratta di un nome abbreviato e createBlammyQ indica che non si tratta di nomi abbreviati.
Sulla pagina della mappa, inizia con un'istruzione come "Alcuni nomi di metodo sono troppo lunghi per adattarsi comodamente ai diagrammi che seguono, in questi casi il nome del metodo inizierà con un asterisco per indicare che si tratta di un nome abbreviato. elenca le mappe sottostanti tra i nomi abbreviati e il nome effettivo del metodo nel codice ". Quindi avere una tabella semplice come questa:
Shortened Name Actual Method Name
createPFCIDbbbbc createPathForCustomerIDblablablabla_click
Dato che hai già un codice e lo stai decodificando in un modello UML, ti consiglio vivamente di mantenere i nomi dei metodi e degli attributi così come sono nel codice. Ciò renderà più facile per qualcuno passare tra il codice e il modello. Tuttavia, l'uso di nomi di funzioni esatte non è richiesto in un diagramma di sequenza. In genere, ho visto questo in precedenza nel processo di progettazione quando vengono utilizzati diagrammi di attività, sequenza e comunicazione per descrivere un caso d'uso. La suddivisione delle classi e delle funzioni può cambiare, ma l'approccio generale è descritto usando nomi che possono o meno diventare i nomi dei metodi.
Stilisticamente, però, nomi di metodi lunghi possono essere considerati un odore di codice (vedi questo articolo del Wiki C2 sugli odori di codice , questo articolo Wiki C2 sull'uso di una buona denominazione e questa domanda Stack Overflow sui nomi di variabili e funzioni lunghe ). Potresti non volerlo refactoring ora, ma forse prenderne nota in qualche modo per rivisitare la prossima volta che stai lavorando con quel codice. Come puoi vedere, i nomi di metodi lunghi possono rendere la documentazione difficile da creare e leggere in futuro, quindi questa è un'altra buona argomentazione per la scelta dei nomi validi in futuro o per il refactoring del codice esistente.
Leggi altre domande sui tag programming-practices uml sequence-diagram