2009-08-07 17 views
5

A veces, para hacer descriptiva una variable/método/nombre de clase, necesito hacerlo más largo. Pero no quiero, me gustaría tener nombres cortos que sean fáciles de leer. Así que pensé en un complemento especial para IDE como Visual Studio para poder escribir nombres cortos para clase, método, campo pero poder adjuntar nombres largos. Si lo necesita, puede hacerlo todo por mucho tiempo o puede hacer un nombre largo. Si desea reducirlo, use la reducción, como dos vistas del mismo código. Me gustaría saber lo que otros piensan al respecto? ¿Crees que es útil? ¿Alguien usaría el tipo de complemento?Reducciones en la programación

+0

Gracias por todas las respuestas. Claro que al elegir multis y multiplicar prefiero multiplicar, pero there's * para eso. Solo imagine multiplicar, en lugar de *. Cada fórmula matemática sería una pesadilla. Estoy hablando de casos en los que la elección entre un nombre largo y descriptivo, corto y fácil de usar no es obvia. P.ej. algunos dominios como las finanzas. Si no conoce el dominio, necesita nombres largos, si lo conoce, puede usarlo brevemente. También no quiero que sea como un nombre en sí mismo, lo veo como otra vista. Como la vista UML para las clases en VS, como el explorador de objetos y el explorador de soluciones. –

Respuesta

6

Nunca me preocupo por los nombres largos. Si el nombre de un método se vuelve demasiado largo, también puede indicar que el método hace demasiado (a menos que incluya una palabra realmente larga). Por otro lado, también trato de evitar repetirme. No tendría Account.AccountId, por ejemplo, sino Account.Id. También me recuesto en el espacio de nombres; si el espacio de nombres es claro sobre en qué dominio estoy, generalmente trato de no repetirlo en nombres de clase o miembros.

Línea inferior; No me veo usando un complemento así.

8

Un nombre de variable debe ser tan largo como sea necesario para hacerlo identificable, ¿importa si es un poco más largo de lo que usted preferiría? ¿Mientras el código sea legible y comprensible, seguramente esto no hace diferencia?

Utilice los comentarios para nombres que serían demasiado largos para usar como nombre de variable/clase. Esto sería mucho más apropiado.

Si un nombre de método es demasiado largo, entonces no debería ser un método único ...

No utilizaría un complemento de esa manera.

4

Otros programadores sin este complemento se encontrarían en problemas porque si da nombres demasiado cortos no entenderán completamente el código, si da nombres largos, perderán tiempo leyendo y, finalmente, se enojarán porque los nombres largos son difíciles de recordar : P

Uno tiene que encontrar el mejor nombre para todo lo que uno escribe, no hay necesidad de un interruptor para activar y desactivar la verbosidad de los identificadores.

No utilizaría ese complemento.

0

No creo que me gustaría.

La sobrecarga de cambiar entre diferentes vistas sería tanto trabajo como presionar F12 y leer el comentario de la función, que siempre será más descriptivo que el nombre largo.

9

¿Por qué no usar simplemente el sistema de comentarios XML estándar integrado en Visual Studio. Si escribe /// sobre la clase/método/variable, etc., crea el talón de comentario. Estos comentarios aparecen a través de Intelisense/Completar código con información adicional.

De esta forma, mantendrá las convenciones de nomenclatura cortas y descriptivas mientras comenta su código. Puede ejecutar un proceso para luego crear documentación para su código usando estos comentarios.

Ver: http://msdn.microsoft.com/en-us/magazine/cc302121.aspx

+1

o '' 'en vb.net – Pondidum

0

No lo haré.

Los nombres de funciones largas pueden ser útiles en algunos casos. Si tienes un caso especial o algo así. Algunos ejemplos:

¿cuál sería su favor para la multiplicación, mul o multiplicación? se multiplican es mi elección

La elección de functionnames es una cuestión de hacer que su código claro para usar, si tiene nombres demasiado pequeños y hay que leer los comentarios de saber lo que hace la función, entonces usted está haciendo mal

1

Tampoco I. El hecho es que estás hablando de VisualStudio. Toma la carga pesada de recordar la mayoría de los nombres de variables (largas y cortas) con IntelliSense. Como dijo Power, siempre que el código sea legible y comprensible, eso es todo lo que importa.

0

IDEs, editores de texto y compiladores son compatibles con la forma limitada (si es que limitada) de la funcionalidad descrita, es decir, los comentarios del código fuente. Creo que los comentarios funcionan muy bien y no veo ninguna necesidad del complemento descrito. Si los comentarios son demasiado largos, pueden ser doblados. Si necesita código fuente sin comentarios, puede quitarlos fácilmente con expresiones regulares de material similar.

0

Me gustaría tener nombres cortos que sean fáciles de leer.

Esto a menudo es una contradicción en los términos.

Tome por ejemplo un nombre como oScBf, si aún no sabe para qué es prácticamente ilegible. ¿Es outputScreenBuffer, onlineSourceBitflag, openScannerBrowsefile, outdoorSpecialBikinifavorites ...?

Los nombres de identificadores largos suelen ser preferibles. A pesar de que es más para leer, es aún más fácil de entender.

El código de lectura es de alguna manera similar a leer el texto. Esperas que siga cierto patrón para ser fácil de leer, si comienzas a agregar una gran cantidad de abreviatura. y las palabras no estándar en da text u hav 2 deja de pensar lo que significa, y pierdes da flow. :)

+0

Estoy de acuerdo con usted. Pero eso es solo si tiene una cosa que necesita reducir. Siempre es mejor escribir un nombre completo para él y todo se está aclarando para su lector. Pero, ¿y si tiene alguna lógica compleja en la que no sabe cómo nombrar variables para que su futuro lector comprenda lo que está sucediendo? Los nombres largos son buenos para explicar todo, pero después de obtener lo que alguna variable quiere reducir y leer sobre otros. si hay 10 elementos, leerá sobre ellos y tendrá que reducir para llegar al algoritmo en sí. –

-2

Me gusta la idea. Es realmente bueno y te gradúo y espero que tengas éxito en desarrollarlo. Aunque nunca usaría un Add-On de este tipo.

+0

Divertida manera de decir que realmente no te gusta – raven

+0

En realidad, me gusta la idea. La razón por la que no lo usaría es porque me he acostumbrado a escribir las cosas de cierta manera, y si comenzara a usarlo, lo seguiría olvidando, y seguiría escribiendo lo que suelo escribir ... La idea es genial Creo que ahorrará mucho tiempo y hará que sea más fácil recordar cosas. Pero no es para mí. Ciertamente no creo que mi opinión personal warrents 2 votos a favor ... –

0

Es una mala idea. Los nombres de variables generalmente no necesitan ser largos para ser adecuadamente descriptivos, perderá mucho tiempo escribiendo dos versiones de cada nombre, y muchos programadores probablemente encontrarán bastante confuso tener múltiples nombres para la misma cosa.

Con ayuda XMLDoc y intellisense, puede agregar cualquier detalle adicional necesario para describir completamente un elemento de código: el nombre no necesita describir las minucias, solo dar una idea clara y distinta de cuál es el propósito del elemento de código.

Con la finalización automática del nombre disponible, ya no hay ninguna razón para quejarse de nombres largos que requieren mucha escritura.

Además, un buen estilo de codificación se trata de hacer que el código sea fácil de leer, comprender y mantener, no de empaquetar más código en un espacio más pequeño.

diseño orientado a objetos debe ayudar a romper la funcionalidad abajo jerárquicamente en espacios de nombres y clases, lo que reduce la necesidad de tales nombres largos a nivel de clase/método)

Por último, si realmente debe acortar nombres, la mayoría de los idiomas más idiomas proporcionan Maneras fáciles de quitar espacios de nombres y/o agregar nuevos alias para los nombres (por ej.'typedef' y 'using' en C++, 'using' en C#), por lo que en una región localizada puede referirse fácilmente a un nombre largo mediante una variante abreviada o un alias si lo desea.

Cuestiones relacionadas