Sou uma pessoa científica que precisa documentar códigos complexos do Matlab para entregar a um desenvolvedor para que ele entenda e programe em um idioma diferente. No passado, eu usei o MS Word (explicando cada etapa do programa como uma nova linha em uma tabela) e depois o Excel, mas não achei particularmente adequado para exibir meu código Matlab e inserir comentários de forma clara e concisa. maneira de documentá-lo.
Gostaria de saber se existe alguma técnica melhor para comunicar pseudo-código a um desenvolvedor. Algum software existente (gratuito?) Ou outra plataforma (por exemplo, TextWrangler) particularmente adequado para fornecer código e algum método para explicá-lo? Na esperança de aprender com as experiências dos outros, fazendo a mesma coisa. Desde já, obrigado.
Depois de ler alguns comentários, deixe-me tentar explicar mais ... Presumo que todos os desenvolvedores conhecem pseudo-código, mas não presumo que muitos conheçam o código Matlab. Portanto, se eu escrever em pseudo-código, posso ignorar o código do Matlab (ou fornecê-lo para referência, etc.). Mas minha pergunta é realmente mais simples ... existe algum software ou plataforma que as pessoas usaram no passado para comunicar claramente o código a um desenvolvedor? Algo que permite que a pessoa que cria o documento descreva facilmente o código? Por exemplo, você pode incorporar códigos que os códigos de cores do software (uma cor para comentários, outra para palavras reservadas (se, então, outra coisa para, etc.), etc.) e, ao longo de um lado, há espaço para eu inserir explicações e referências, etc. Tentei fazer isso usando produtos MS, mas pensei que há uma indústria de pessoas que precisa fazer a mesma coisa,
%
inicia um comentário e, em seguida, gostaria de adicionar comentários explicativos ao código do Matlab. E deixe-me voltar com perguntas sobre coisas que não faziam sentido para mim. Isso seria mais fácil por toda parte.