優(yōu)先使用“為什麼”註釋而非“做什麼”註釋，因?yàn)榍罢咛峁┐a無(wú)法表達(dá)的背景或業(yè)務(wù)邏輯；2. 避免重複代碼已明確表達(dá)的內(nèi)容，應(yīng)通過(guò)改進(jìn)變量或函數(shù)命名提升可讀性；3. 利用PHPDoc塊註釋說(shuō)明函數(shù)功能，保持內(nèi)聯(lián)註釋專註解釋決策原因，從而提升代碼可維護(hù)性並節(jié)省後續(xù)開(kāi)發(fā)時(shí)間。

When it comes to writing PHP code, comments are one of those things developers either ignore completely or overdo with robotic precision. But the real value isn't just in adding comments—it's in understanding why you're commenting versus just explaining what the code does.

The Problem with “What” Comments

You've probably seen this a thousand times:

 // Set user status to active
$user->status = 'active';

This is a classic example of a what comment—it literally just repeats the code in plain English. It adds zero value. If your code needs this kind of comment to be understood, the real issue is that the code itself is unclear or poorly named.

What comments usually mean:

• The variable or function name isn't expressive enough
• You're documenting the obvious
• You're wasting time writing something the next developer (or you in 3 months) already knows

The Power of “Why” Comments

Now consider this:

 // Temporarily mark as active—this user bypassed email verification due to legacy import
$user->status = 'active';

That's a why comment. It explains the reasoning behind the code. It tells you something the code itself can't: context, history, or business logic nuance.

Why comments are valuable because they:

• Reveal the intent behind a non-obvious decision
• Help future developers avoid “fixing” something that isn't broken
• Document edge cases or legacy behavior that might otherwise be lost
• Save hours of digging through Git history or Slack threads

When to Use Each

? Use why comments when:

• There's a workaround for a third-party bug
• A decision was made based on business rules that aren't obvious
• You're doing something “wrong” on purpose (eg, performance optimization)
• The logic seems counterintuitive without context

? Avoid what comments unless:

• You're teaching someone (like in a tutorial)
• You're working with extremely complex logic that even good naming can't clarify (rare!)

Bonus Tip: Use DocBlocks for “What”

If you feel compelled to explain what a function does, that's what PHPDoc is for:

 /**
 * Updates user status to active.
 * @param User $user
 * @return void
 */
public function activateUser(User $user)
{
    $user->status = 'active';
}

That's structured, machine-readable, and doesn't clutter your logic. Save inline comments for the why .

Bottom line:
Write code that explains the what , and use comments to explain the why .
That's how you make your PHP code both readable and maintainable—without wasting time.

以上是PHP評(píng)論：為什麼與什麼的詳細(xì)內(nèi)容。更多資訊請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！