From dcde78eef2798a3ef7dc8a86e27abaa7acd168c3 Mon Sep 17 00:00:00 2001 From: Jakub Vrana Date: Mon, 24 Mar 2025 17:21:44 +0100 Subject: [PATCH] Document //! --- developing.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/developing.md b/developing.md index 7c9d0062..d21d4fea 100644 --- a/developing.md +++ b/developing.md @@ -81,6 +81,8 @@ All functions have doc-comments, but redundancy is avoided. For example, `Db` me Inline comments are useful for linking specifications but are generally avoided for explaining self-explanatory code. They start with a lowercase letter and do not end with a period, though I am not entirely happy with this convention. +Comments starting with `//!` mean TODO. + ## Error Handling Adminer strictly initializes all variables before use, which is [verified](https://github.com/vrana/php-initialized). However, Adminer relies on the default value of uninitialized array items. This approach leads to more readable code. Consider the following examples: