1.8 Keywords to FrequentRules: a. T

1.8 Keywords to Frequent

Rules:

a. The static keyword shall be used to declare all functions and variables that do not need to be visible
outside of the module in which they are declared.
b. The const keyword shall be used whenever appropriate. Examples include:
i. To declare variables that should not be changed after initialization,
ii. To define call-by-reference function parameters that should not be modified (e.g., char const * param),
iii. To define fields in structs and unions that should not be modified (e.g., in a struct overlay for memory-mapped I/O peripheral registers), and
iv. As a strongly typed alternative to #define for numerical constants.
c. The volatile keyword shall be used whenever appropriate. Examples include:
i. To declare a global variable accessible (by current use or scope) by any interrupt service routine,


ii. To declare a global variable accessible (by current use or scope) by two or more tasks,
iii. To declare a pointer to a memory-mapped I/O peripheral register set (e.g., timer_t volatile * const p_timer), and
iv. To declare a delay loop counter.

Reasoning: C’s static keyword has several meanings. At the module-level, global variables and functions declared static are protected from external use. Heavy-handed use of static in this way thus decreases coupling between modules. The const and volatile keywords are even more important. The upside of using const as much as possible is compiler-enforced protection from unintended writes to data that should be read-only. Proper use of volatile eliminates a whole class of difficult-to-detect bugs by preventing compiler optimizations that would eliminate requested reads or writes to variables or registers.5
Exceptions: None.






5 Anecdotal evidence suggests that programmers unfamiliar with the volatile keyword think their compiler’s optimization feature is more broken than helpful and disable optimization. We believe that the vast majority of embedded systems contain bugs waiting to happen due to missing volatile keywords. Such bugs typically manifest themselves as “glitches” or only after changes are made to a “proven” code base.


Enforcement: Appropriate use of these important keywords shall be enforced during code reviews.

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

1.8 các từ khóa để thường xuyênQuy tắc: a. từ khóa tĩnh sẽ được sử dụng để tuyên bố tất cả các chức năng và các biến mà không cần phải được nhìn thấybên ngoài các mô-đun trong đó họ được tuyên bố.sinh từ khoá const sẽ được sử dụng bất cứ khi nào thích hợp. Ví dụ bao gồm:i. để khai báo biến mà không cần phải được thay đổi sau khi khởi tạo,II. để xác định thông số cuộc gọi bằng cách tham khảo chức năng mà không cần sửa đổi (ví dụ như, char const * param),III. để xác định các lĩnh vực trong structs và công đoàn nên không được thay đổi (ví dụ như, một lớp phủ struct cho bộ nhớ ánh xạ I/O ngoại vi có đăng ký), vàIV. như là một thay thế mạnh mẽ đánh máy để #define cho hằng số.c. từ khoá dễ bay hơi sẽ được sử dụng bất cứ khi nào thích hợp. Ví dụ bao gồm:i. để khai báo một biến toàn cầu có thể truy cập (bằng cách sử dụng hiện tại hoặc phạm vi) bởi bất kỳ gián đoạn dịch vụ thói quen, II. để khai báo một biến toàn cầu có thể truy cập (bằng cách sử dụng hiện tại hoặc phạm vi) bởi hai hoặc nhiều nhiệm vụ,III. để khai báo một con trỏ đến một bộ nhớ ánh xạ I/O ngoại vi đăng ký thiết lập (ví dụ như, timer_t dễ bay hơi * const p_timer), vàIV. tuyên bố một sự chậm trễ truy cập vòng lặp.Lý luận: Các từ khóa tĩnh của C có nhiều ý nghĩa. Ở cấp độ mô-đun, biến toàn cầu và chức năng tuyên bố tĩnh được bảo vệ từ sử dụng bên ngoài. Nặng tay sử dụng tĩnh bằng cách này do đó làm giảm các khớp nối giữa mô-đun. Từ khoá const và dễ bay hơi là quan trọng hơn. Ngược của việc sử dụng XD càng nhiều càng tốt là thực thi biên dịch bảo vệ từ viết không mong đợi để dữ liệu cần được chỉ-đọc. Các sử dụng phù hợp của bay hơi loại bỏ một lớp học toàn bộ của khó khăn để phát hiện lỗi bằng cách ngăn chặn tối ưu hóa trình biên dịch sẽ loại bỏ yêu cầu lần đọc hoặc viết để biến hoặc registers.5Ngoại lệ: không có. 5 các bằng chứng giai thoại cho thấy rằng các lập trình viên không quen thuộc với từ khoá dễ bay hơi nghĩ của trình biên dịch tối ưu hóa tính năng bị phá vỡ hơn hữu ích và vô hiệu hóa tối ưu hóa. Chúng tôi tin rằng phần lớn các hệ thống nhúng chứa lỗi chờ để xảy ra do thiếu từ khoá dễ bay hơi. Lỗi như vậy thường biểu hiện bản thân như "ổn định" hoặc chỉ sau khi thay đổi được thực hiện cho một mã "cung cấp khả năng" cơ sở. Thực thi pháp luật: Các sử dụng phù hợp của các từ khóa quan trọng sẽ được áp dụng trong mã đánh giá.

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

1.8 Từ khoá để thường xuyên Rules: a. Các từ khóa tĩnh được sử dụng để khai báo tất cả các chức năng và các biến mà không cần phải được nhìn thấy bên ngoài của các mô-đun, trong đó họ được khai báo. B. Các từ khóa const sẽ được sử dụng bất cứ khi nào thích hợp. Các ví dụ bao gồm: i. Để khai báo các biến đó không nên được thay đổi sau khi khởi tạo, ii. Để xác định cuộc gọi bằng cách tham khảo các thông số chức năng mà không cần phải được sửa đổi (ví dụ, const char * param), iii. Để xác định các lĩnh vực trong cấu trúc và các đoàn thể mà không cần được sửa đổi (ví dụ, trong một cấu trúc overlay cho bộ nhớ ánh xạ I / O ghi ngoại vi), và iv. Là một thay thế mạnh mẽ đánh tới # define cho các hằng số. C. Các từ khóa volatile sẽ được sử dụng bất cứ khi nào thích hợp. Các ví dụ bao gồm: i. Để khai báo một biến thể truy cập (bằng cách sử dụng hiện tại, phạm vi) của bất kỳ thói quen gián đoạn dịch vụ toàn cầu, ii. Để khai báo một biến thể truy cập (bằng cách sử dụng hiện tại, phạm vi) của hai hoặc nhiều nhiệm vụ toàn cầu, iii. Để khai báo một con trỏ đến một bộ nhớ ánh xạ I / O ngoại vi bộ đăng ký (ví dụ, timer_t dễ bay hơi * p_timer const), và iv. Để khai báo một sự chậm trễ vòng lặp phản. Reasoning: từ khóa tĩnh C có nhiều nghĩa. Tại các mô-đun cấp, các biến toàn cầu và chức năng khai báo tĩnh được bảo vệ từ bên ngoài sử dụng. Sử dụng nặng tay của tĩnh theo cách này vì thế giảm khớp nối giữa các module. Các từ khóa const và biến động thậm chí còn quan trọng hơn. Mặt tích cực của việc sử dụng const càng nhiều càng tốt là bảo vệ biên dịch thi hành từ ghi không ngờ cho dữ liệu đó phải được chỉ đọc. Sử dụng hợp lý dễ bay hơi giúp loại bỏ một lớp học toàn bộ khó khăn để phát hiện lỗi bằng cách ngăn chặn tối ưu hóa trình biên dịch mà sẽ yêu cầu cùng tiêu diệt lần đọc hoặc viết cho các biến hoặc registers.5 Ngoại lệ:. Không 5 bằng chứng cho thấy rằng các lập trình viên không quen với các từ khóa volatile nghĩ rằng trình biên dịch của họ Tính năng tối ưu hóa là hơn bị hỏng hơn tối ưu hóa hữu ích và vô hiệu hóa. Chúng tôi tin rằng phần lớn các hệ thống nhúng có lỗi chờ để xảy ra do thiếu các từ khóa dễ bay hơi. Lỗi này thường tự biểu hiện như "ổn" hay chỉ sau khi các thay đổi được thực hiện cho một "chứng minh" cơ sở mã. Enforcement: Thích hợp sử dụng các từ khóa quan trọng sẽ được thi hành trong đánh mã.