2.1 Acceptable FormatsRules:a. Sing

2.1 Acceptable Formats

Rules:

a. Single-line comments in the C++ style (i.e., preceded by //) are a useful and acceptable alternative to traditional C style comments (i.e., /* … */).6
b. Comments shall never be nested.
c. Comments shall never be used to disable a block of code, even temporarily.
i. To temporarily disable a block of code, use the preprocessor’s conditional compilation feature (e.g., #if 0 … #endif). No block of temporarily disabled code shall remain in the source code of a release candidate.









6 This is a deviation from [MISRA04] Rule 2.2, which we feel will not affect the number or severity of firmware bugs. The C++ “single-line” style makes comments easier to align and maintain. In addition this deviation is consistent with our choice of the [C99] language, which officially added single-line comments to the C language.


ii. Any line or block of code that exists specifically to increase the level of debugging output information shall be surrounded by
#ifndef NDEBUG … #endif.7 In this way, useful debug code may be maintained in production code, as the ability to gather additional information is often desirable long after development is done.
Reasoning: Nested comments and commented-out code both run the risk of allowing unexpected snippets of code to be compiled into the final executable. This can happen, for example, in the case of sequences such as /* code-out /* comment */ code-in */.
Exceptions: None.

Enforcement: The use of only acceptable comment formats can be only partially enforced by the compiler or static analysis. The avoidance of commented-out code, for example, must be enforced during code reviews.








7 Our choice of negative-logic NDEBUG is deliberate, as that constant is associated with disabling the assert() macro. In both cases, the programmer acts to disable the verbose code. It’s also good to have just one of these #defines to keep track of.

Kết quả (Việt) 1:

2.1 chấp nhận được định dạngQuy tắc:a. đơn dòng ý kiến trong phong cách C++ (tức là, trước bằng / /) là một thay thế hữu ích và chấp nhận được để truyền thống C phong cách ý kiến (tức là, / *... * /).6 sinh ý kiến không bao giờ sẽ được lồng nhau.c. ý kiến không bao giờ sẽ được sử dụng để vô hiệu hóa một khối mã, thậm chí tạm thời.i. để tạm thời vô hiệu hóa một khối mã, sử dụng của preprocessor có điều kiện biên soạn tính năng (ví dụ như, #if 0... #endif). Không có khối mã Khuyết tật tạm thời thì vẫn còn trong mã nguồn của một ứng cử viên phát hành. 6 đây là một sự chệch hướng từ [MISRA04] quy tắc 2.2, mà chúng tôi cảm thấy sẽ không ảnh hưởng đến số lượng hoặc mức độ nghiêm trọng của lỗi phần vững. Phong cách "một dòng" C++ làm cho ý kiến dễ dàng hơn để sắp xếp và duy trì. Ngoài ra, độ lệch này là phù hợp với chúng tôi lựa chọn của ngôn ngữ [C99], mà chính thức thêm ý kiến đơn dòng vào ngôn ngữ C. II. bất kỳ dòng hoặc khối mã mà tồn tại cụ thể để tăng mức độ sản lượng thông tin gỡ lỗi sẽ được bao quanh bởi#ifndef NDEBUG... #endif.7 bằng cách này, hữu ích gỡ lỗi mã có thể được duy trì trong sản xuất mã, như khả năng thu thập thông tin bổ sung thường là mong muốn lâu sau khi phát triển được thực hiện.Lý do: Bình luận lồng nhau và nhận xét ra mã cả hai chạy nguy cơ cho phép bất ngờ đoạn mã để được biên dịch thành file thực thi cuối cùng. Điều này có thể xảy ra, ví dụ, trong trường hợp của chuỗi như / * mã-out / * bình luận * / mã trong * /.Ngoại lệ: không có.Thực thi: Việc sử dụng định dạng chỉ chấp nhận được bình luận có thể được chỉ có một phần thi hành bởi trình biên dịch hoặc tĩnh phân tích. Tránh nhận xét ra mã, ví dụ, phải được áp dụng trong mã đánh giá. 7 chúng tôi lựa chọn của tiêu cực-logic NDEBUG là cố ý, là hằng số đó là liên kết với vô hiệu hóa vĩ mô assert(). Trong cả hai trường hợp, các lập trình viên hoạt động để vô hiệu hóa mã tiết. Nó cũng là tốt để có chỉ là một trong #defines để theo dõi.

Kết quả (Việt) 2:

2.1 Các định dạng được chấp nhận Quy định: a. Comments đơn dòng trong C ++ phong cách (tức là, trước bởi //) là một lựa chọn hữu ích và có thể chấp nhận với ý kiến C phong cách truyền thống (chẳng hạn như / * ... * /). 6 b. Ý kiến thì không bao giờ được lồng vào nhau. C. Ý kiến thì không bao giờ được sử dụng để vô hiệu hóa một khối mã, thậm chí tạm thời. I. Để tạm thời vô hiệu hóa một khối mã, sử dụng tính năng biên dịch có điều kiện của tiền xử lý (ví dụ, # nếu 0 ... #endif). Không có khối mã tạm thời bị vô hiệu hóa thì vẫn trong mã nguồn của một ứng cử viên phát hành. 6 này là một sai từ [MISRA04] Quy tắc 2.2, mà chúng tôi cảm thấy sẽ không ảnh hưởng đến số lượng hoặc mức độ nghiêm trọng của lỗi firmware. The C ++ "single-line" phong cách đưa ra bình luận dễ dàng hơn để điều chỉnh và duy trì. Ngoài ra độ lệch này là phù hợp với sự lựa chọn của chúng ta về [C99] ngôn ngữ, trong đó chính thức bổ sung ý kiến single-line với ngôn ngữ C. Ii. Bất kỳ dòng hoặc khối mã mà tồn tại đặc biệt để tăng mức độ thông tin gỡ lỗi đầu ra được bao quanh bởi #ifndef NDEBUG ... # endif.7 Bằng cách này, gỡ lỗi mã hữu ích có thể được duy trì trong mã sản xuất, như khả năng thu thập thông tin bổ sung là thường mong muốn lâu sau khi phát triển được thực hiện. Lý luận: Các ý kiến Nested và mã nhận xét ​​ra cả hai chạy các nguy cơ của việc cho phép các đoạn bất ngờ mã sẽ được biên dịch vào chạy cuối cùng. Điều này có thể xảy ra, ví dụ, trong trường hợp của các trình tự như / * Mã-out / * Nhận xét ​​* / code-in * /. Trường hợp ngoại lệ:. Không Enforcement: Việc sử dụng các định dạng comment chỉ chấp nhận có thể được thực thi chỉ một phần bởi trình biên dịch hoặc phân tích tĩnh. Tránh sự nhận xét ​​mã-ra, ví dụ, phải được thi hành trong thời đánh mã. 7 sự lựa chọn của chúng tôi về âm-logic NDEBUG là cố ý, như không thay đổi được kết hợp với việc vô hiệu hóa assert () vĩ mô. Trong cả hai trường hợp, các lập trình viên sẽ hành động để vô hiệu hóa mã verbose. Nó cũng tốt để có được một trong những # định nghĩa để theo dõi.