Aprenda a documentar seus projetos em Objective-C - Revista Mobile Magazine 48

Num ambiente de programação ágil, usando metodologias como Scrum, Agile e Lean, nem sempre há tempo de documentar os códigos-fonte. Afinal, pragmáticos como são os desenvolvedores, por que perderiam tempo se a documentação não será compilada, não fará a menor diferença na execução do programa e demanda uma fatia considerável de tempo do desenvolvedor? Mas independentemente disso tudo, documentação faz falta. Muita falta.

Quem está familiarizado, sabe que no ritmo acelerado das startups tudo o que é feito é “para ontem” e nem sempre há tempo para aplicar algumas das boas práticas de programação que não são fundamentais ao bom funcionamento e à agilidade do código. Diversas vezes deixa-se de testar formalmente classes e métodos em função do prazo virtualmente nulo que é passado. É fácil descobrir desenvolvedores virando noite para que consigam lançar no dia seguinte aquela funcionalidade chave. Testar? Documentar? Revisar? Tantas coisas para fazer num tempo tão curto!

Essa é a realidade de muitos jovens desenvolvedores, que entram nesse ambiente competitivo em busca do sonho de abrir a própria empresa. A obrigação de satisfazer potenciais investidores, a cobrança por entregas e as necessidades do cliente frequentemente ofuscam técnicas que melhoram a experiência de desenvolvimento e manutenção, porém que não são consideradas primordiais para o funcionamento de uma aplicação. Quantas vezes não se volta a um código não documentado feito há menos de dois meses antes e pensa-se “o que esse loop faz?”, ou então “por que essa classe está aqui e não ali?” Obviamente, quando aquelas linhas de código foram escritas, tudo fazia total sentido, porém, assim que aqueles ifs e fors saíram da mente consciente, seu significado, há muito, já havia deixado de ser importante. Afinal, como diz o provérbio chinês, “a tinta é melhor que a memória”.

Então, documentemos. Na verdade, documentar é como comer legumes: ninguém realmente gosta, mas fazemos o sacrifício pois esperamos que, no final, valha o resultado. A documentação comprovadamente facilita as nossas vidas. Ao contrário do que se pensa, o tempo gasto documentando o trabalho de um dia é razoavelmente irrelevante e o benefício que temos em troca, definitivamente compensa esse trabalho.