Move all files to sculpin/
This commit is contained in:
parent
c5d71803a5
commit
0f61b4e9ee
1514 changed files with 0 additions and 0 deletions
23
sculpin/source/_posts/2023-09-22.md
Normal file
23
sculpin/source/_posts/2023-09-22.md
Normal file
|
@ -0,0 +1,23 @@
|
|||
---
|
||||
title: >
|
||||
Documentation and comments get stale. Tests don't.
|
||||
pubDate: 2023-09-22
|
||||
permalink: >-
|
||||
daily/2023/09/22/documentation-and-comments-get-stale
|
||||
tags:
|
||||
- software-development
|
||||
- automated-testing
|
||||
- static-analysis
|
||||
---
|
||||
|
||||
I'm sure you've seen code comments that say the code will do something when, in fact, it does something different.
|
||||
|
||||
Or documentation that has become outdated and stale and no longer correct.
|
||||
|
||||
Automated tests and other tools, such as static analysis, are executable documentation, so they can't become stale.
|
||||
|
||||
If the implementation code changes and no longer matches the tests, the tests will fail, and either the implementation or test can be updated.
|
||||
|
||||
Then, if you need to refer to the test, as long as it's passing, you know what it shows is still applicable.
|
||||
|
||||
The same can't be said for markdown files, Confluence pages, Word documents or other static documentation.
|
Loading…
Add table
Add a link
Reference in a new issue