search

genbetadev / Genbeta-Dev-Engine

Desarrollo de un Game Engine básico sobre C++ y SFML 2.1
MIT License
63 stars 32 forks source link

Documentar clase ConfigCreate #28

Open adrigm opened 10 years ago

RdlP commented 10 years ago

Esto lo puedo hacer yo mañana también (hasta las 5 de la tarde hora española no podré, así que si alguien lo hace antes que lo ponga por aquí)

adrigm commented 10 years ago

Mientras nadie ponga nada todo tuyo @RdlP

RdlP commented 10 years ago

Al final hoy no podré hacerlo, mañana me encargaré si nadie lo ha hecho ya

ficion commented 10 years ago

Voy a intentar hacerlo mañana si es que puedo. Me costó un poco entender la clase, sólo por el hecho de que se llama "ConfigCreate"; ¿no debería ser "ConfigCreator"?

Bueno, primero tengo que leer cómo trabaja la clase y ahí creo que documentaré algo.

Duda, @adrigm: ¿Por qué nombras a la variable, anResult? No es que tenga nada malo, sólo es curiosidad.

RdlP commented 10 years ago

@ficion Si quieres hacerlo tú, todo tuyo.

adrigm commented 10 years ago

@ficion cierto que debería llamarse ConfigCreator o ConfigMaker, deberíamos refactorizar para cambiarlo.

La nomenclatura es a causa de otro proyecto en el que colabore en el que se implementó la clase configReader y era la que se usaba, no por nada especial, pero me parece buena nombrar a variables genéricas con un "an" delante y la de los parámetros con un "the"