Difference between revisions of "Metapatterns"
| (One intermediate revision by one user not shown) | |||
| Line 5: | Line 5: | ||
You have total freedom in what you want to pick, but the more patterns you adhere to, the higher your chances that someone further down the track will be able to understand and make good use of the software. | You have total freedom in what you want to pick, but the more patterns you adhere to, the higher your chances that someone further down the track will be able to understand and make good use of the software. | ||
| − | If and when you choose to follow the metapattern approach, you will need to add some standardized comments to your script. | + | If and when you choose to follow the metapattern approach, you will need to add some standardized comments to the heading of your script to indicate which patterns you used: one or more comment-lines of the form |
| + | |||
| + | http://metapattern.info/PATTERNAME | ||
| + | |||
| + | where PATTERNAME is one of the metapattern codes below. | ||
This to clearly communicate which metapatterns you had in mind while building the software. | This to clearly communicate which metapatterns you had in mind while building the software. | ||
| Line 18: | Line 22: | ||
[[REGULAR_TABS]] | [[REGULAR_TABS]] | ||
[[TERSE_README]] | [[TERSE_README]] | ||
| + | [[TEXT]] | ||
[[ZIP]] | [[ZIP]] | ||
Latest revision as of 10:00, 6 April 2017
Most software developers will know many or most of these patterns.
You can choose to follow one or more of these metapatterns when you create scripts.
You have total freedom in what you want to pick, but the more patterns you adhere to, the higher your chances that someone further down the track will be able to understand and make good use of the software.
If and when you choose to follow the metapattern approach, you will need to add some standardized comments to the heading of your script to indicate which patterns you used: one or more comment-lines of the form
http://metapattern.info/PATTERNAME
where PATTERNAME is one of the metapattern codes below.
This to clearly communicate which metapatterns you had in mind while building the software.
These metapatterns are merely suggestions. You can make up your own mind how rigorously or how loosely you want to apply any of them, if at all.
A lot of these metapatterns will seem incredibly obvious to a software developer. It is important to keep in mind that they are not necessarily obvious to a non-developer.
ALPHABETIZE LINE_END_CRLF READABLE REGULAR_TABS TERSE_README TEXT ZIP
