標注函式行為

除了批註函式 參數和傳回值之外,您還可以標注整個函數的屬性。

函數注釋

下列註釋適用於整個函式,並描述它的行為或它預期成立的項目。

Annotation Description
_Called_from_function_class_(name) 這個述詞不適合單獨使用,而是要搭配 _When_ 註釋使用。 如需詳細資訊,請參閱 指定套用注釋的時機和位置

name參數是任一字元串,也會出現在 _Function_class_ 部分函式宣告的注釋中。 _Called_from_function_class_ 如果目前正在分析的函式使用 _Function_class_ 具有相同值的 name 標注,則會傳回非零,否則會傳回零。
_Check_return_ 標注傳回值,並指出呼叫端應該檢查它。 如果函式是在 void 內容中呼叫,則檢查程式會報告錯誤。
_Function_class_(name) name 參數是使用者指定的任意字串。 它會存在彼此不同的命名空間中。 函式、函式指標或最常見的函式指標類型都可以指定為屬於一個或多個函式類別。
_Raises_SEH_exception_ 標註一定會引發結構化例外狀況處理常式 (SEH) 例外狀況的函式 (受 _When__On_failure_ 條件所限制)。 如需詳細資訊,請參閱 指定套用注釋的時機和位置
_Maybe_raises_SEH_exception_ 標註可以選擇性引發 SEH 例外狀況的函式 (受 _When__On_failure_ 條件所限制)。
_Must_inspect_result_ 標注任何輸出值,包括傳回值、參數和 globals。 如果在標註的物件中未接著檢查值,分析器就會報告錯誤。 「檢查」包括值是否用於條件運算式、指派給輸出參數或全域,或是做為參數傳遞。 針對傳回值, _Must_inspect_result_ 表示 _Check_return_
_Use_decl_annotations_ 可用於函式定義 (也稱為函式主體) 用來取代標頭中的注釋清單。 使用時 _Use_decl_annotations_ ,會使用出現在相同函式之範圍標頭中的注釋,如同它們也出現在具有 _Use_decl_annotations_ 批註的定義中。

成功/失敗注釋

函式可能會失敗,當它失敗時,其結果可能不完整或與函式成功時的結果不同。 下列清單中的註釋提供了表示失敗行為的方式。 若要使用這些註釋,您必須啟用它們來判斷是否成功,因此必須有 _Success_ 註釋。 請注意,NTSTATUSHRESULT 已有內建的 _Success_ 註釋。不過,如果您在 _Success_NTSTATUS 上指定自己的 HRESULT 註釋,它就會覆寫內建註釋。

Annotation Description
_Always_(anno_list) 相當於 anno_list _On_failure_(anno_list),也就是說,無論函式是否成功,都會套用 anno_list 中的註釋。
_On_failure_(anno_list) 只有在同時使用 _Success_ 標註函式時才使用,無論是明確使用,或是在 typedef 上透過 _Return_type_success_ 隱含使用。 當 _On_failure_ 註釋出現在函式參數或傳回值上時,在 anno_list (anno) 中每個註釋的行為就如同撰寫成 _When_(!expr, anno) 的程式碼,其中 expr 是所需 _Success_ 註釋的參數。 這表示,對所有後置條件的 _Success_ 的隱含用法不適用於 _On_failure_
_Return_type_success_(expr) 可套用至 typedef。 指出傳回該類型且未明確擁有 _Success_ 的所有函式,都會標註為如同擁有 _Success_(expr)_Return_type_success_ 無法在函式或函式指標 typedef 上使用。
_Success_(expr) expr 是產生右值的運算式。 當 _Success_ 註釋出現在函式宣告或定義上時,函式上和後置條件中每個註釋 (anno) 的行為就如同撰寫為 _When_(expr, anno) 程式碼一樣。 _Success_ 註釋只能在函式上使用,而不能在其參數或傳回型別上使用。 函式上最多只能有一個 _Success_ 註釋,而且不能在任何 _When__At__Group_ 中。 如需詳細資訊,請參閱 指定套用注釋的時機和位置

另請參閱