如果你是C開發人員請看這三個顯式程式設計技巧

大雄45發表於2022-02-15
導讀 嵌入式系統開發人員應儘可能明確,以避免 ASSUME 綜合症並在其系統中產生意外行為。在今天的文章中,讓我們來看看嵌入式開發人員可以透過更明確的方式清理程式碼的幾個領域。

嵌入式系統開發人員應儘可能明確,以避免 ASSUME 綜合症並在其系統中產生意外行為。在今天的文章中,讓我們來看看嵌入式開發人員可以透過更明確的方式清理程式碼的幾個領域。

如果你是C開發人員請看這三個顯式程式設計技巧如果你是C開發人員請看這三個顯式程式設計技巧

Mix of office supplies and gadgets on a wooden desk background. View from above.

顯式程式設計技巧 #1 – 將 extern 與公共函式一起使用

我們都知道我們不應該使用 extern,因為它會建立全域性變數,進而可能導致各種問題。但是,實際使用 extern 的一個好地方是在建立公共函式時。

當你定義一個公開的函式時,你可以使用以下 在標頭中建立宣告或原型:

void Foo(void);

它在標題中,所以很明顯它是一個公共的外部函式。但是,我遇到過這樣的情況,你正在維護一個別人編寫的模組,並且在像 Bar 這樣的函式的標頭中沒有公共 API,但它的定義如下:

void Bar(void)
{
…
}

這個函式的目的是什麼? 它應該是私有的並且前面有一個靜電嗎?它應該是公開的並在標題中定義嗎?如果嵌入式開發人員將 Bar 定義為:

extern Bar(void)
{
…
}

我們會知道它是公開的並且在 API 中缺失,儘管有人呼叫它,連結器仍然能夠找到它。

顯式程式設計技巧 #2 – 將指標作為 const 傳遞給函式,除非它們改變

指標是危險的,如果它們在執行過程中意外地以某種意想不到的方式遞增、遞減或修改,它們很容易導致災難。我經常會遇到如下所示的函式宣告:

void Foo(uint32_t * Param1);

這個宣告是如此含蓄,我讀了這個宣告,其目的是將一個指標傳遞給一個 uint32_t,其中指標和指向的 uint32_t 記憶體位置都允許更改!

這是嵌入式開發人員的本意嗎? 如果他們只是想傳遞一個指向變數的指標,以便它透過引用傳遞並且可以被函式修改怎麼辦? 這個函式可以做到這一點,但他們也開啟了修改指標的選項!

下面的陳述對我來說非常清楚,指標不會改變,指向的值可以改變:

void Foo(uint32_t * const Param1);

引數是指向 uint32_t 記憶體位置的 const 指標。指標在函式中不能改變,但指向的東西可以。因此,如果有人在函式中執行以下操作:

Param++;

編譯器會說“不! 錯誤!”,讓維護者明白他們不應該這樣做。

顯式程式設計技巧 #3 – 將“no reference”變數作為 const 傳遞

現在,這通常會讓嵌入式開發人員興奮不已,而且不是很好。有人告訴我這是無稽之談,但同樣,它使包括新手在內的任何開發人員都清楚程式碼。

這裡的想法是我可能有一個宣告如下的函式:

void Foo(uint32_t Param1);

在這種情況下,我透過副本而不是引用傳遞引數,以供函式使用。該函式理論上可以對本地副本執行任何操作。但同樣,如果有人在維護這段程式碼,他們是否知道我們想要接收引數並將其用作常量? 對我來說,除非宣告是這樣寫的,否則我不會有任何線索:

void Foo(const uint32_t Param1);

這告訴我,該引數預計不會在副本中更改或修改以供本地使用。

這些提示有助於使程式碼更清晰,並有助於嵌入式開發人員理解程式碼的真正意圖。現在,這些可能不是導致所有這些損失的隱式程式碼的最佳做法,但它們確實讓你認為你應該編寫儘可能清晰的軟體。

原文來自: https://www.linuxprobe.com/three-explicit-programming-skills-c-development.html

來自 “ ITPUB部落格 ” ,連結:http://blog.itpub.net/69955379/viewspace-2855689/,如需轉載,請註明出處,否則將追究法律責任。

相關文章