Readable code9/11/2023 If we're working in a team to develop some code then readable source code can ensure that everyone can understand the code written by everyone else. They may assume that we undertake our research in a similarly slack manner. If our code is badly laid out, messy and cryptic, others will assume that it is also buggy and sloppily written. Or, to put it another way, would we rather have a peer spot a problem now, or, six months later when we've published a paper based on flawed results produced using our software? Readable code can help our fellow researchers to understand what we've done and so to assess whether this aspect of our research is correct. Our code may embody some unique aspect of our research. We may understand our code now, but what about six months or a year from now? Readable code helps us to reaquaint ourselves with what we wrote and why we wrote it. It may end up being processed by a machine, but it evolves in our hands and we need to understand what the code does and where changes need to be made. With increasing requirements for researchers to make their source code available, we thought this guide would be a useful resource for researchers developing software, to ensure that the code they produce is understandable by their peers. We can even review your source code to see whether it can be improved. The Software Sustainability Institute can provide advice and guidance on producing readable source code. If our peers are to quickly and easily understand our source code, it must be readable.
0 Comments
Leave a Reply.AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |