documentation - Source Code and comments for prototype development -


I am involved in a prototype development. We can not say that this is completely prototype development. It is partly following the procedures defined within the organization. As far as customer related it is a prototype development.

Problem Documentation We do not have the time required and architectural design is not set to design and prepare detailed designs. Although I have created an architecture for the system and have created a simple document explaining the architecture and the main components. Because it is necessary to share between the members of the team and the new people who come in the projects. All other implementation details remain within the code. For example, we're using several image processing algorithms, which are not officially formulated as a document. Everything remains inside the code and the brain that created it. We can not be sure that any special resource is always available in the organization or can not always keep it for that particular task.

My question is, how extensive comments should be contained within the code. This code trash will appear, if it is overloaded with comments, but for some more time it is necessary to keep the source readable and maintain later it will become a product.

A good test for the weather requires a comment to pretend you did not write the code ( Or if you do not have anybody who does not write it which will be better) go through the code and see if it makes sense, whatever goes in front of the straight forward, it should be commented further.

This is really hard if you write the code yourself, but since your team takes some time so that your team reviews the code of others. It will also help in spreading knowledge about your code base, when you lose your resources, at least the team members have seen the code.

Although you have classified this code as a prototype, my guess is that you transition out of the prototype phase that you do not start throwing your existing code and start from scratch. Commenting and documentation should be sufficient to assist in this, so your current code is going to take and increase it.

The idea of ​​the prototype code is a naive person. You have a code that is ready to produce and which is not a code.


Comments

Post a Comment

Popular posts from this blog

python - Overriding the save method in Django ModelForm -

I'm having trouble overriding a ModelForm save method. I get this error I'm: Exception type: TypeErier Exception Value: Save () found an unexpected keyword argument 'committed' My intentions include a form 3 fields Submit several values ​​for, then create an object for each combination of those areas, and to save each object file models.py class collarsult type (models.Model): id = model. AutoField (db_column = 'icontact_result_code_type_id', primary_key = true) callResult = models.ForeignKey ( 'CallResult', db_column = 'icontact_result_code_id') campaign = models.ForeignKey ( 'campaign', db_column = 'icampaign_id') CALLTYPE = models.ForeignKey ( 'CALLTYPE', db_column = 'icall_type_id') agent = models.BooleanField (db_column = 'bagent', default = true) teamLeader = models.BooleanField (db_column = 'bTeamLeader', default = true) active = models.BooleanField (db_column = Django.form...
Read more

html - CSS autoheight, but fit content to height of div -

I have a div in which there are three children- div in the left and middle div: float: left while true: float: true because it is my layout Actually will spoil, I've used ClearFix Hack: .cf {zoom: 1; }. Cf: First,. Cf: {content: ""; Display: Table; }. Cf: After {clear: both; } It still works, but I want to be the right div an indicator. So it should fill 100% of the parent unit of height. How can I complete this? PS is the full code: & Lt; / Div & gt; & Lt; Div class = "mobile_content" & gt; & Lt; H5 & gt; {{Data.titel}} & lt; / H5> & Lt; Table & gt; & Lt; TR & gt; & Lt; Th & gt; Komponist: & lt; / Th & gt; & Lt; TD & gt; {{Data.komponist}} & lt; / TD & gt; & Lt; / TR & gt; & Lt; TR & gt; & Lt; Th & gt; Instrument: & lt; / Th & gt; & Lt; TD & gt; {{Data.instrumente}} & lt; / TD & gt; & Lt; / TR & gt;...
Read more

qt - How to prevent QAudioInput from automatically boosting the master volume to 100%? -

I have been trying to use Qt5 multimedia to record audio with QAudioInput, however, when I see If QAudioInput is started, it increases the master volume of my sound device to 100%. How can I prevent QAudioInput from changing the master volume? My current development platform is Linux with PalsAdio (with flat audio disabled). How can I use QAudioInput : QAudioDeviceInfo device_info = QAudioDeviceInfo :: defaultInputDevice (); QAudio format format; Format.setSampleRate (44100); Format.setChannelCount (1); Format.setSampleSize (16); Format.setCodec ("Audio / PCM"); Format.setSampleType (QAudioFormat :: SignedInt); Format.setByteOrder (QAudioFormat :: LittleEndian); Std :: cout & lt; & Lt; Device_info.deviceName (). ToUtf8 (). ConstData () & lt; & Lt; Std :: endl; QAudioInput * default_device = new QAudioInput (device_info, format); QIODevice * default_io_device = default_device-> Start (); a QAudioInput.setVolume () method is not you I ...
Read more