kèo bóng đá pháp chính phải ngắn, thực tế và tránh tham chiếu đến các chi tiết thực hiện như tên chức năng cụ thể.11022_11025ngắnHồicó nghĩa làsẽ phù hợp với một dòng trong điều kiện bình thường11172_11530

Ví dụ: thay vì:

(cộng với một phụ lục dài về cơ bản là một gợi ý)

Viết:

Chính: kèo bóng đá pháp thể tạo đoạn bộ nhớ được chia sẻ: %m
Chi tiết: Syscall thất bại là shmget (key =%d, size =%u, 0%o).
Gợi ý: Phụ lục

11920_12386

Đừng đặt bất kỳ giả định cụ thể nào về định dạng vào các văn bản tin nhắn. Mong khách khách hàng và nhật ký máy chủ bao gồm các dòng phù hợp với nhu cầu của riêng họ. Trong các kèo bóng đá pháp điệp dài, các ký tự mới (\ n) có thể được sử dụng để chỉ ra các đoạn văn được đề xuất. Đừng kết thúc một tin nhắn với một dòng mới. Không sử dụng các tab hoặc các ký tự định dạng khác. .

Rationale: Tin nhắn không nhất thiết phải được hiển thị trên màn hình kiểu thiết bị đầu cuối. Trong GUI Hiển thị hoặc trình duyệt, các hướng kèo bóng đá pháp định dạng này được bỏ qua tốt nhất.

Văn bản tiếng Anh nên sử dụng dấu ngoặc kép khi trích kèo bóng đá pháp là phù hợp. Văn bản bằng các ngôn ngữ khác nên liên tục sử dụng một loại trích kèo bóng đá pháp phù hợp với xuất bản hải quan và đầu ra máy tính của các chương trình khác.

13631_14128

Luôn luôn sử dụng kèo bóng đá pháp giá để phân định tên tệp, định danh người dùng do người dùng cung cấp và các biến khác có thể chứa các từ. Không sử dụng chúng để đánh dấu các biến sẽ không chứa các từ (ví dụ: tên toán tử).

Có các chức năng trong phần phụ trợ sẽ xử lý gấp đôi đầu ra của chúng khi cần thiết (ví dụ:format_type_be ()). Không đặt kèo bóng đá pháp giá bổ sung xung quanh đầu ra của các chức năng đó.

14779_15004

Các quy tắc khác nhau cho các kèo bóng đá pháp chính và cho thông báo chi tiết/gợi ý:

kèo bóng đá pháp chính: Không viết hoa chữ cái đầu tiên. Không kết thúc một tin nhắn với một khoảng thời gian. Thậm chí không nghĩ về việc kết thúc một tin nhắn với một dấu chấm than.

kèo bóng đá pháp điệp chi tiết và gợi ý: Sử dụng các câu hoàn chỉnh và kết thúc mỗi câu với một khoảng thời gian. Viết hoa từ đầu tiên của câu. Đặt hai khoảng trống sau khoảng thời gian nếu một câu khác theo sau (đối với văn bản tiếng Anh; có thể không phù hợp trong các ngôn ngữ khác).

Chuỗi ngữ cảnh kèo bóng đá pháp: Không viết hoa chữ cái đầu tiên và không kết thúc chuỗi bằng một khoảng thời gian. Các chuỗi ngữ cảnh thường không phải là câu hoàn chỉnh.

Rationale: Tránh dấu câu giúp các ứng dụng khách hơn dễ dàng nhúng kèo bóng đá pháp điệp vào nhiều ngữ cảnh ngữ pháp. kèo bóng đá pháp thường, các kèo bóng đá pháp điệp chính không phải là câu hoàn chỉnh về mặt ngữ pháp. . Để thống nhất, họ nên theo phong cách toàn phần ngay cả khi chỉ có một câu.

Sử dụng chữ thường cho từ ngữ tin nhắn, bao gồm chữ cái đầu tiên của kèo bóng đá pháp chính. Sử dụng trường hợp trên cho các lệnh SQL và các từ khóa nếu chúng xuất hiện trong thông báo.

Rationale: dễ dàng hơn để làm cho mọi thứ trông ổn định hơn theo cách này, vì một số tin nhắn là câu hoàn chỉnh và một số kèo bóng đá pháp.

Sử dụng giọng nói đang hoạt động. Sử dụng các câu hoàn chỉnh khi có một chủ đề diễn xuất (MạnhA kèo bóng đá pháp thể làm b). Sử dụng phong cách Telegram mà kèo bóng đá pháp có chủ đề nếu chủ đề sẽ là chương trình; kèo bóng đá pháp sử dụngHồiiHồicho chương trình.

Đặt vấn đề: Chương trình kèo bóng đá pháp phải là con người. Đừng giả vờ khác.

Sử dụng thì quá khứ nếu cố gắng làm điều gì đó thất bại, nhưng có lẽ có thể thành công vào lần tới (có lẽ sau khi khắc phục một số vấn đề). Sử dụng thì hiện tại nếu thất bại chắc chắn là vĩnh viễn.

Có sự khác biệt ngữ nghĩa kèo bóng đá pháp cần thiết giữa các câu của biểu mẫu:

kèo bóng đá pháp thể mở tệp " %s": %m

và:

kèo bóng đá pháp thể mở tệp "%s"

Cái đầu tiên có nghĩa là nỗ lực mở tệp không thành công. kèo bóng đá pháp sẽ đưa ra một lý do, chẳng hạn nhưHồiĐĩa đầy đủhoặcTệp kèo bóng đá pháp tồn tạiHàng. Thì quá khứ là phù hợp vì lần tới đĩa có thể kèo bóng đá pháp còn đầy nữa hoặc tệp trong câu hỏi có thể tồn tại.

18563_18797

18807_19004

Khi trích kèo bóng đá pháp tên của một đối tượng, hãy nêu nó là loại đối tượng.

Đặt vấn đề: Nếu kèo bóng đá pháp thì kèo bóng đá pháp ai sẽ biếtHồifoo.bar.bazđề cập đến.

dấu ngoặc vuông chỉ được sử dụng (1) trong các bản tóm tắt lệnh để biểu thị các đối số tùy chọn hoặc (2) để biểu thị chỉ số mảng.

Đặt vấn đề: Bất cứ điều gì khác không tương ứng với việc sử dụng kèo bóng đá pháp thường được biết đến rộng rãi và sẽ gây nhầm lẫn cho mọi người.

20077_20160

kèo bóng đá pháp thể mở tệp %s: %m

20237_20579

Tin nhắn phải luôn nói lên lý do tại sao xảy ra kèo bóng đá pháp. Ví dụ:

xấu: kèo bóng đá pháp thể mở tệp %s
Tốt hơn: kèo bóng đá pháp thể mở tệp %s (i/o thất bại)

Nếu kèo bóng đá pháp có lý do nào được biết, bạn sẽ sửa mã tốt hơn.

Không bao gồm tên của thói quen báo cáo trong văn bản lỗi. Chúng tôi có các cơ chế khác để tìm ra điều đó khi cần thiết và đối với hầu hết người dùng, đó không phải là kèo bóng đá pháp tin hữu ích. Nếu văn bản lỗi không có ý nghĩa nhiều nếu không có tên chức năng, hãy làm lại nó.

xấu: pg_strtoint32: kèo bóng đá pháp trong "z": không thể phân tích được "z"
Tốt hơn: Cú pháp đầu vào không hợp lệ cho loại số nguyên: "Z"

Tránh đề cập đến tên chức năng được gọi là; Thay vào đó hãy nói những gì mã đang cố gắng làm:

BAD: Open () kèo bóng đá pháp thành công: %m
Tốt hơn: kèo bóng đá pháp thể mở tệp %s: %m

Nếu nó thực sự có vẻ cần thiết, hãy đề cập đến cuộc gọi hệ thống trong kèo bóng đá pháp chi tiết. (Trong một số trường hợp, việc cung cấp các giá trị thực tế được truyền vào cuộc gọi hệ thống có thể là thông tin phù hợp cho kèo bóng đá pháp chi tiết.)

Đặt vấn đề: Người dùng kèo bóng đá pháp biết tất cả các chức năng đó làm gì.

kèo bóng đá pháp thể. kèo bóng đá pháp thểgần như là giọng nói thụ động. Sử dụng tốt hơn22529_22537Hồihoặckèo bóng đá pháp thểHồi, khi thích hợp.

xấu.kèo bóng đá pháp nhưHồiKết quả xấuthực sự khó diễn giải kèo bóng đá pháp minh. Tốt hơn là viết tại sao kết quả làHồixấu, ví dụ:HồiĐịnh dạng kèo bóng đá pháp hợp lệ.

bất hợp kèo bóng đá pháp. bất hợp kèo bóng đá phápHồilà viết tắt của vi phạm kèo bóng đá pháp luật, phần còn lại làkèo bóng đá pháp hợp lệ. Tốt hơn nữa, hãy nói tại sao nó kèo bóng đá pháp hợp lệ.

kèo bóng đá pháp xác định.cố gắng tránhMạnhkèo bóng đá pháp xác định. Coi nhưkèo bóng đá pháp: phản hồi không xác định. Nếu bạn kèo bóng đá pháp biết phản hồi là gì, làm thế nào để bạn biết nó sai?kèo bóng đá pháp được công nhậnthường là lựa chọn tốt hơn. Ngoài ra, hãy chắc chắn bao gồm giá trị bị phàn nàn.

xấu: loại nút kèo bóng đá pháp xác định
Tốt hơn: Loại nút kèo bóng đá pháp được công nhận: 42

Tìm so với tồn tại.Nếu chương trình sử dụng thuật toán không cần thiết để xác định vị trí tài nguyên (ví dụ: tìm kiếm đường kèo bóng đá pháp) và thuật toán đó không thành công, thật công bằng khi nói rằng chương trình không thểTìmHồiTài nguyên. Mặt khác, nếu vị trí dự kiến ​​của tài nguyên được biết nhưng chương trình kèo bóng đá pháp thể truy cập nó ở đó thì nói rằng tài nguyên kèo bóng đá phápMạnhtồn tại. Sử dụngTìmxôngTrong trường hợp này nghe có vẻ yếu và gây nhầm lẫn vấn đề.

Có thể so với có thể so với Might. có thểHồiđề xuất sự cho phép (ví dụ: "bạn có thể mượn cào của tôi.") Và ít sử dụng trong tài liệu hoặc kèo bóng đá pháp.HồiCANHồiđề xuất khả năng (ví dụ: "Tôi có thể nâng nhật ký đó.") Vàcó thểHồiđề xuất khả năng (ví dụ: "Trời có thể mưa hôm nay."). Sử dụng từ thích hợp làm rõ ý nghĩa và hỗ trợ dịch.

co thắt.Tránh các cơn co thắt, nhưkèo bóng đá pháp thểxông; sử dụngkèo bóng đá pháp thểHồiThay vào đó.

kèo bóng đá pháp âm.Tránhkèo bóng đá pháp âmHàngVì nó mơ hồ về việc liệu nó có chấp nhận kèo bóng đá pháp. Tốt hơn là sử dụngMạnhlớn hơn 0HồihoặcMạnhlớn hơn hoặc bằng kèo bóng đá phápHồi.

đánh vần đầy đủ các từ. Chẳng hạn, tránh:

Đặt vấn đề: Điều này sẽ cải thiện tính nhất quán.

Hãy nhớ rằng các văn bản kèo bóng đá pháp cần được dịch sang các ngôn ngữ khác. Thực hiện theo các hướng dẫn trongPhần 55.2.2Để tránh làm cho cuộc sống trở nên khó khăn cho các dịch giả.