sudoc:su_prog_rules
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| sudoc:su_prog_rules [2019/07/30 21:40] – seisunix | sudoc:su_prog_rules [2019/07/30 21:55] (current) – seisunix | ||
|---|---|---|---|
| Line 20: | Line 20: | ||
| The reality is that the more items that a user must fetch to install your code, the less likely that they will want to use it. You will also be at the mercy of whims of third party developers who may decide arbitrarily to change their code. | The reality is that the more items that a user must fetch to install your code, the less likely that they will want to use it. You will also be at the mercy of whims of third party developers who may decide arbitrarily to change their code. | ||
| + | |||
| ===== Do not include commercial software ===== | ===== Do not include commercial software ===== | ||
| Line 29: | Line 30: | ||
| The limitation is that while code released under a Berkeley License may be absorbed into a GPL software collection, the reverse is not true. You may not include GPL licensed code in the SU distribution. | The limitation is that while code released under a Berkeley License may be absorbed into a GPL software collection, the reverse is not true. You may not include GPL licensed code in the SU distribution. | ||
| + | |||
| + | ===== Avoid using global variables ===== | ||
| + | If you need to pass a variable to a subroutine then pass it as an argument to the subroutine, do not define it as a global variable. | ||
| + | |||
| + | ===== Document your code thoroughly ===== | ||
| + | Make sure there are Notes: in the Self Documentation. | ||
| + | Document each declared variable. Put technical information describing the algorithm being used. Remember that " | ||
| + | |||
| + | Document subroutines as though they will be clipped out and put in a library---because if a subroutine is useful, it will be separated from its parent program. | ||
| + | |||
| + | Pretend that the code will not run without the documentation. | ||
| ===== Develop from existing code ==== | ===== Develop from existing code ==== | ||
| Line 102: | Line 114: | ||
| </ | </ | ||
| - | ** The end self documentation flag ** | + | ** The end self documentation flag, this tells updatedoc that this is the end of the documentation** |
| < | < | ||
| / | / | ||
| Line 250: | Line 262: | ||
| } | } | ||
| if (icount==0) warn(" | if (icount==0) warn(" | ||
| + | </ | ||
| + | ** Dynamic allocation which hides " | ||
| + | < | ||
| /* Allocate fft arrays */ | /* Allocate fft arrays */ | ||
| Line 260: | Line 275: | ||
| polygonalFilter(f, | polygonalFilter(f, | ||
| + | </ | ||
| + | |||
| + | ** note that most of the time we loop over input traces, these are in "do -- while" loops ** | ||
| + | < | ||
| /* Main loop over traces */ | /* Main loop over traces */ | ||
| do { | do { | ||
| Line 371: | Line 390: | ||
| </ | </ | ||
| - | |||
| - | |||
sudoc/su_prog_rules.1564522811.txt.gz · Last modified: 2019/07/30 21:40 by seisunix