opdavies/oliverdavies.uk
1
0
Fork 0
Code Issues 1 Pull requests Projects 1 Releases Packages Wiki Activity Actions

tome export

Browse source
This commit is contained in:
Oliver Davies 2025-05-30 02:14:32 +01:00
parent 52278c3a53
commit 7a52afab5f
960 changed files with 3670 additions and 2229 deletions
Download patch file Download diff file Expand all files Collapse all files

6
content/node.4a1294d7-248e-48f8-bfae-b49bbe1d19b4.json
View file

@ -82,15 +82,15 @@
],
"body": [
{
"value": "\n <p>How often have you need code like this?<\/p>\n\n<pre><code class=\"php\">\/\/ Returns true.\nreturn false;\n<\/code><\/pre>\n\n<p>Whilst a comment like this could have been true when it was written, the code can change independently of the comment - making them out of sync and the comment no longer true.<\/p>\n\n<p>As the comment is not evaluated or executed, there isn't a way to validate whether it's still correct, so whilst it could be, it may not be.<\/p>\n\n<p>Comments should describe why the code is needed, not what it does.<\/p>\n\n<p>If a comment describes the functionality, it can be refactored and extracted to a class, method or function - a.k.a. self-documenting code.<\/p>\n\n<p>But, if you want something that will alert you if the functionality changes, look into <a href=\"/atdc\">automated testing<\/a>.<\/p>\n\n<p>If you have a passing test that suddenly starts to fail, you know the behaviour has changed.<\/p>\n\n ",
"value": "\n <p>How often have you need code like this?<\/p>\n\n<pre><code class=\"php\">\/\/ Returns true.\nreturn false;\n<\/code><\/pre>\n\n<p>Whilst a comment like this could have been true when it was written, the code can change independently of the comment - making them out of sync and the comment no longer true.<\/p>\n\n<p>As the comment is not evaluated or executed, there isn't a way to validate whether it's still correct, so whilst it could be, it may not be.<\/p>\n\n<p>Comments should describe why the code is needed, not what it does.<\/p>\n\n<p>If a comment describes the functionality, it can be refactored and extracted to a class, method or function - a.k.a. self-documenting code.<\/p>\n\n<p>But, if you want something that will alert you if the functionality changes, look into <a href=\"\/atdc\">automated testing<\/a>.<\/p>\n\n<p>If you have a passing test that suddenly starts to fail, you know the behaviour has changed.<\/p>\n\n ",
"format": "full_html",
"processed": "\n <p>How often have you need code like this?<\/p>\n\n<pre><code class=\"php\">\/\/ Returns true.\nreturn false;\n<\/code><\/pre>\n\n<p>Whilst a comment like this could have been true when it was written, the code can change independently of the comment - making them out of sync and the comment no longer true.<\/p>\n\n<p>As the comment is not evaluated or executed, there isn't a way to validate whether it's still correct, so whilst it could be, it may not be.<\/p>\n\n<p>Comments should describe why the code is needed, not what it does.<\/p>\n\n<p>If a comment describes the functionality, it can be refactored and extracted to a class, method or function - a.k.a. self-documenting code.<\/p>\n\n<p>But, if you want something that will alert you if the functionality changes, look into <a href=\"/atdc\">automated testing<\/a>.<\/p>\n\n<p>If you have a passing test that suddenly starts to fail, you know the behaviour has changed.<\/p>\n\n ",
"processed": "\n <p>How often have you need code like this?<\/p>\n\n<pre><code class=\"php\">\/\/ Returns true.\nreturn false;\n<\/code><\/pre>\n\n<p>Whilst a comment like this could have been true when it was written, the code can change independently of the comment - making them out of sync and the comment no longer true.<\/p>\n\n<p>As the comment is not evaluated or executed, there isn't a way to validate whether it's still correct, so whilst it could be, it may not be.<\/p>\n\n<p>Comments should describe why the code is needed, not what it does.<\/p>\n\n<p>If a comment describes the functionality, it can be refactored and extracted to a class, method or function - a.k.a. self-documenting code.<\/p>\n\n<p>But, if you want something that will alert you if the functionality changes, look into <a href=\"http:\/\/default\/atdc\">automated testing<\/a>.<\/p>\n\n<p>If you have a passing test that suddenly starts to fail, you know the behaviour has changed.<\/p>\n\n ",
"summary": null
}
],
"feeds_item": [
{
"imported": "1970-01-01T00:33:45+00:00",
"imported": "1970-01-01T00:32:50+00:00",
"guid": null,
"hash": "39666fa6935e0010996ee0d41ac7462b",
"target_type": "feeds_feed",