低級程序員才喜歡寫注釋!

作者 | Tameem Iftikhar

譯者 | 平川

策劃 | Tina

注釋不同于《辛德勒的名單》。它們不是“純善的”。事實(shí)上，注釋充其量是一種必要的惡。——Robert C.Martin

// 匹配電子郵件地址的正則表達(dá)式var re = /^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/;return re.test(String(email).toLowerCase());// 注意：添加一個(gè)富于表現(xiàn)力的函數(shù)名，注釋就變得沒有必要了function validateEmail(email) {var re = /^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/;return re.test(String(email).toLowerCase());}

for x in range(1, 500):
# 這是運(yùn)行多個(gè)并行測試時(shí)預(yù)防死鎖的最好方法  time.sleep(0.5)  runTest(x)

"""  許多 Qt 函數(shù)都不是線程安全的。如果你使用回調(diào)函數(shù)，  即使你在所有繪制調(diào)用代碼的周圍都加上鎖，你也會遇到段錯誤，  因?yàn)?Qt 的主事件循環(huán)仍在運(yùn)行，并且使用了沒加鎖的資源。"""from multiprocessing.pool import ThreadPoolimport sysfrom threading import Lockimport timefrom PyQt5 import QtCore, QtWidgetsclass Task(QtCore.QObject):    updated = QtCore.pyqtSignal(int, int)    ...............    ...............

/*** 與該容器相關(guān)的集群*/protected Cluster cluster = null;/*** 人類可讀的容器名*/protected String name = null;/*** 該容器的父容器*/protected Container parent = null;/*** 創(chuàng)建一個(gè) Loader 配置父類加載器*/protected ClassLoader parentClassLoader = null;

def load_config():try:    do_useful_stuff()except Exception as ex:# 如有異常，退回到默認(rèn)狀態(tài)。

-----------------------------# Exhibit A# 默認(rèn)構(gòu)造函數(shù)def get_todays_date():return date.today()-----------------------------# Exhibit B# 返回月份的天# @return: 月份的天def get_day_of_month()return day_of_month

class ComplexNumber:"""    這是一個(gè)用于復(fù)數(shù)的數(shù)學(xué)運(yùn)算類。
    屬性：        real (int)：復(fù)數(shù)的實(shí)部。        imag (int)：復(fù)數(shù)的虛部。    """
def __init__(self, real, imag):"""        ComplexNumber 類的構(gòu)造函數(shù)。
        參數(shù)：           real (int)：復(fù)數(shù)的實(shí)部。           imag (int)：復(fù)數(shù)的虛部。        """
def add(self, num):"""        該函數(shù)用于復(fù)數(shù)求和。
        參數(shù)：            num (ComplexNumber)：要加的復(fù)數(shù)。
        返回值：            ComplexNumber：包含和的復(fù)數(shù)。        """
        re = self.real + num.real        im = self.imag + num.imag
return ComplexNumber(re, im)
help(ComplexNumber)  # 訪問類的 docstringhelp(ComplexNumber.add)  # 訪問方法的 docstring

# 檢查日期是否是過去的日期def check_date(date):if date < today:return truereturn false
def is_past_date(date):if date < today:return truereturn false

/*這段代碼糟透了。我知道，你知道，每個(gè)人都知道。我們假裝什么都沒發(fā)生，然后繼續(xù)前進(jìn)。以后你叫我白癡好了。*/

有道無術(shù)，術(shù)可成；有術(shù)無道，止于術(shù)

歡迎大家關(guān)注Java之道公眾號

好文章，我在看??