¿Qué consideraría realmente un mejor estilo de codificación: declarar los nombres de los parámetros de funciones/métodos dentro del encabezado, o solo en el archivo de origen, ya que es posible hacer ambas cosas? Si realmente considera declarar nombres de parámetros de funciones/métodos solo en el archivo fuente, ¿cómo declararía los valores predeterminados?¿Las declaraciones de funciones deberían incluir nombres de parámetros?
CABEC.:EXT.TEXTO:
//One.hpp
#ifndef ONE_HPP
#define ONE_HPP
namespace eins {
/** \brief description
*
* \param one represents ....
* \param two represents ....
*/
void function(int,int);
}
#endif
// One.cpp
#include "One.hpp"
eins::function(int one,int two) {
//Do stuff//
}
Dentro de cabecera:
//One.hpp
#ifndef ONE_HPP
#define ONE_HPP
namespace eins {
/** \brief description
*
* \param one represents ....
* \param two represents ....
*/
void function(int one,int two);
}
#endif
// One.cpp
#include "One.hpp"
eins::function(int one,int two) {
//Do stuff//
}
Mi punto de vista personal es que la primera es mejor, ya que el usuario está realmente obligado a leer los comentarios/API y no se puede equivocar al solo leer los nombres de los parámetros. Pero no estoy seguro de esto y, en realidad, declarar los valores predeterminados podría romper mi estilo, ya que tiene que hacer eso en la declaración del encabezado de una función/método.
Está falsamente asumiendo que necesita incluir un nombre de parámetro para declarar un valor predeterminado para un parámetro. Esto está perfectamente bien: 'función vacía (int, int = 0)'. Es un parámetro sin nombre con un valor predeterminado. –
Para contrarrestar su comentario acerca de que los consumidores están equivocados por los nombres formales de los parámetros, creo que es una indicación de parámetros mal nombrados. La documentación es * mejor * para las cosas que no se pueden describir fácilmente en el código, como el "por qué" de una sección de código en particular. –