análisis de código se vuelve con la sugerencia acerca de no usar los parámetros de "fuera"

Question

me encontré con la herramienta de análisis de código VS 2008 contra un objeto que creé y recibí la siguiente sugerencia ...

Advertencia 147 CA1021: Microsoft.Design : considere un diseño que no requiere que 'returnValue' sea un parámetro de salida.

Encontré los parámetros de "salida" bastante útiles y no me di cuenta de que se los consideraba una práctica de diseño desaprobada. Quería saber si alguien podría arrojar algo de luz sobre el motivo por el que recibí esta Advertencia. Si es una mala práctica? ¿por qué? y ¿cuál sería una buena práctica?

Agradezco cualquier consejo.

Answer 1

Cada advertencia de Análisis de código tiene documentación asociada a la que puede acceder resaltando la advertencia y presionando F1. También puede hacer clic derecho en el elemento para obtener ayuda.

En cualquier caso, aquí está el documentation that explains that particular warning.

Diría que hay algunos casos en los que los parámetros de salida siguen siendo una buena opción, especialmente cuando se trata del lenguaje de codificación TryParse, porque es una manera bien establecida de hacer las cosas que la mayoría de la gente debe entender es

En uso general, sin embargo, hay soluciones mejores y más orientadas a objetos para valores de retorno múltiples.

Answer 2

Una vez corrí el análisis del código en mi proyecto. También recibí muchas sugerencias interesantes, muy brevemente apagué esto. Muchas de las sugerencias son de naturaleza religiosa, puedes hacerlo de una u otra forma, una cuestión de estilo y no una mala práctica.

A su situación. Si solo tiene un parámetro de retorno, devuélvalo a la función.

Si también tiene un código de retorno que ocupa el lugar de devolución, considere usar excepciones para informar al código de llamante de los errores de operación.

Si tiene muchos parámetros para devolver que están estrechamente relacionados entre sí, haga una clase/estructura para mantenerlos juntos y devolverlos como un paquete.

Answer 3

Apagué esta advertencia específica en la mayoría de mis proyectos. Dado que, sé que, cuando uso un parámetro de salida, tengo una buena razón para hacerlo, ya que trato de evitarlos por completo.

que podía imaginar sin embargo, que, cuando se trabaja con varias personas en un proyecto, es posible que desee tener esta advertencia encendida si quiere hacer algunas revisiones de código ...

Answer 4

Muchas de las advertencias de análisis de código parecen para mí ser relevante para escribir el código API que utilizarán los terceros. Su regla con parámetros de 'salida' es un caso clásico: parte del motivo por el que no se usan es porque muchos otros programadores no los conocerán.

Si no coinciden con lo que está escribiendo, apague las reglas de análisis de código que no le convienen. Personalmente, tiendo a desactivar las reglas de nomenclatura, portabilidad e interoperabilidad ya que no son relevantes para el tipo de código que escribo.