Sử dụng các bình luận lint với doxygen

Question

Đối với tài liệu, chúng ta thường phải tạo một tài liệu bổ sung mô tả những gì chúng tôi đã làm khi bất kỳ tin nhắn lint nào bị vô hiệu hóa trong mã (e.g. /* lint --e228). Nó sẽ làm cho nó dễ dàng hơn nhiều để sử dụng nó với doxygen (như chúng tôi tạo ra dù sao đi nữa).

Mặc dù, tôi không thể tìm thấy bất kỳ giải pháp nào về cách tạo doxygen bằng cách sử dụng các lint nhận xét này. Có ai thử điều này không? Có giải pháp nào về cách sử dụng stric '/*lint' nhưng dù sao, hãy thêm nó vào doxygen?

Cảm ơn!

Answer 1

Điều này có thể được thực hiện bằng cách xác định macro để mở rộng vào nhận xét biểu thức lint, nhưng làm cho macro mở rộng thành nhận xét khác khi được mở rộng bằng doxygen.

Bí quyết là sử dụng các hướng dẫn -save để PC-lint ^TM hoặc FlexeLint ^TM:

#ifndef LINT_CONTROL 
#define LINT_CONTROL(X) /*lint -save X */ //lint X 
#endif 

int main() { 
    int a; LINT_CONTROL(-e530) 
    return a != a; 
} 

Sau đó, trong tập tin cấu hình doxygen của bạn, bạn có thể bật mở rộng macro tiền xử lý nhất định. Cụ thể, chúng tôi có thể thay đổi LINT_CONTROL để mở rộng thành một chú thích doxygen.

ENABLE_PREPROCESSING = YES 
MACRO_EXPANSION  = YES 
EXPAND_ONLY_PREDEF  = YES 
PREDEFINED    = "LINT_CONTROL(X)=//! lint control: X" 

Ngoài ra, nếu bạn có FlexeLint ^TM, sau đó bạn có thể sửa đổi mã nguồn bao phủ để bình luận doxygen thể được sử dụng để kích hoạt sự kiểm soát lint. Kỹ thuật này được mô tả trên Gimpel Software Discussion Forum.

_{PC-lint và FlexeLint là thương hiệu của Phần mềm Gimpel.}