A software company's personnel have liquidity. A programmer inside the company has left newcomers, so that this newcomer understands and understands the module that the programmer who will leave, is not related to the relevant code notes. , But even if you add a comment, the newcomer is also very likely to spend a lot of time to understand, because a small piece of the code does not say that you can see the entire module, after all, there is always always existed Sustaining a certain context, it is necessary to fully understand that the work of the programmer will still pay a lot of time as the price, which has a small impact on the project. And even "old people" (especially for large items) that have been working for the module, there will be certain forgotten when a part is not contacted. At this time, I have to understand it again. Spends a lot of time. Even if the system designer of the project is left, the problem is even more, if the replacement does not understand the original designer's design idea, the project has a considerable risk. Can these problems can be alleviated by certain methods. . .
Sitting on the bamboo chair, I suddenly came to an inexplicable idea, why not record the work of programmers and system designers and even other projects into sound files or video files. For example, after a program is written after a function of the program, you will use the recorded microphone that you have a vernoted oral description of the function, such as the function name, what is the function of the function, etc. Regular text notes Also described, then you can record how you implement this function, what method is adopted (on the details), why do you do this, any meaning, you can also record some precautions to call the function, I can even attach some of the defects of this function, and so on, etc., what do you want to record? The recording of the work of the system designer is more meaningful, such as why he adopts the XXX design architecture, why do you have such a module, a member of the structure and classes, why do you have any effect, class What is the relationship between the class, many things can be, and it should be recorded. After all, the designer and the realizes that their person can provide information can provide information. The amount of information can be described much from the text document. Guide is much more than a single expression of a single text (otherwise the teacher is going to do, it is to join the developed person can quickly integrate into the team in this way. At the same time, voice recording is very convenient, don't say anything else, the speed of speaking is definitely better than typing or writing speed (don't tell me that you are too lazy), and the company can exercise in this way Oral expression ability, this communication and communication on company employees, even the implementation of the project is quite good.
My way is to finish, now give an example. For example, a function is designed
Void Cguy :: Playfootball (where * phere)
{
.......................
}
You can record your ports of this function as file guy_playfootball.wav, if you are too big, you can record guy_playfootball.mp3, you decide yourself, if you like to make video files with sound, you also You can record some of your operations for more convenient use, of course, this is the bigger the hard drive, the better :)
If you also try to try to try to try there is a big question inside: a sound file is not every place I want to listen, you are right, I am also I didn't want to think about it, I was writing this whole idea before writing this article, I am going to be put out in this way. I think that you can partition the sound file, different districts, such as a regular area, which can have a regular area, which is usually seen in the text code of the program; setting A design idea area, putting oral description of the code details of the implementation; set a call precaution, put some questions that call functions need to pay attention to, etc., there is a partition information to retrieve it. . I think my ideas will have a lot of shortcomings and problems, but I just want to see it valuable side :) If this idea is a little bit a little bit, at least I think it will be useful, for me For the compiler and the CVS software can put these things, this is more cool, for those who want the Open Source, it provides these sound information, we don't have to take the headache! ! ! ! ! Here, this article is not rigorous and neat, please forgive it, if you have any thoughts, you can send an email to my email yuang_157@163.com, follow you, BYE
