Tag Info

Hot answers tagged

9

Neither foolish nor crafty I believe: MATLAB software is used for very serious engineering, science, finance, and many other fields. This being the case, MathWorks (the company that develops Matlab) are very careful not to publicly document things that they are not 100% certain will remain as-is in future Matlab versions. There are numerous examples of such ...


6

Don't do it. There is no proper way of doing it. Documenting which places a function gets called from is a remnant of the structured programming paradigm of the seventies and the eighties. I actually do remember back in 1989 a professor asking us to document functions this way; I never heard of anyone doing such a thing ever since. This paradigm has been ...


6

Ever since I read RFC 2119, I began to put a reference to it in specifications - even code documentation. A comment like the following somewhere in the documentation helps set the standard for interpretation. The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document ...


2

TL;DR Leakage of implementation detail due to MATLAB ".m" files being shipped in source code form. Frequent changes of software requirements, features, and implementation detail. Complexity due to many different underlying dependencies, all of which suffer from the phenomenons listed here. Every complex software system (consisting of multiple ...


1

Repeating information at the beginning of each source code file makes IMHO only sense to minimize the risk of separation of license & copyright information from the particular file. So if that information is already stored elsewhere, the absolute minimum you should add is a reference to the place where to find that information. If someone sends you a ...



Only top voted, non community-wiki answers of a minimum length are eligible