| PostgreSQL 9.2.24 Tài liệu | ||||
|---|---|---|---|---|
| prev | UP | Chương 47. PostgreSql Coding quy ước | Tiếp theo | |
kèo chấp bóng đá hôm nay này được cung cấp với hy vọng duy trì Phong cách nhất quán, thân thiện với người dùng trong tất cả các tin nhắn được tạo bởiPostgreSQL.
kèo chấp bóng đá hôm nay điệ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ư chức năng cụ thể tên."ngắn"có nghĩa là"sẽ phù hợp với một dòng theo bình thường điều kiện". Sử dụng một kèo chấp bóng đá hôm nay chi tiết nếu cần để giữ Tin nhắn chính ngắn, hoặc nếu bạn cảm thấy cần phải đề cập chi tiết triển khai như hệ thống cụ thể gọi là thất bại. Cả thông điệp chính và chi tiết nên là thực tế. Sử dụng một tin nhắn gợi ý cho các đề xuất về những việc cần làm để sửa chữa vấn đề, đặc biệt là nếu đề xuất có thể không phải lúc nào cũng áp dụng.
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: Không 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
Đặt vấn đề: Giữ thông điệp chính ngắn giúp giữ nó đến mức và cho phép khách hàng bố trí không gian màn hình trên Giả định rằng một dòng là đủ cho các kèo chấp bóng đá hôm nay. Chi tiết và các tin nhắn gợi ý có thể được chuyển xuống chế độ dài dòng hoặc Có lẽ là một cửa sổ chi tiết lỗi bật lên. Ngoài ra, chi tiết và gợi ý Thông thường sẽ bị triệt tiêu từ nhật ký máy chủ để tiết kiệm không gian. Tham khảo chi tiết triển khai là tránh tốt nhất vì người dùng Dù sao cũng không biết chi tiết.
12544_13014
Đặt vấn đề: Tin nhắn không nhất thiết phải được hiển thị Màn hình kiểu thiết bị đầu cuối. Trong GUI Hiển thị hoặc trình duyệt này Hướng kèo chấp bóng đá hôm nay định dạng là tốt nhất bị bỏ qua.
Văn bản tiếng Anh nên sử dụng dấu ngoặc kép khi trích kèo chấp bóng đá hôm nay là phù hợp. Văn bản bằng các ngôn ngữ khác nên sử dụng một cách nhất quán Một loại trích kèo chấp bóng đá hôm nay phù hợp với phong tục xuất bản và đầu ra máy tính của các chương trình khác.
Cơ sở lý luận: Lựa chọn trích kèo chấp bóng đá hôm nay kép trên các trích kèo chấp bóng đá hôm nay đơn là Hơi tùy ý, nhưng có xu hướng sử dụng ưa thích. Một số đã đề nghị chọn loại trích kèo chấp bóng đá hôm nay tùy thuộc vào loại đối tượng theo quy ước SQL (cụ thể là chuỗi Trích kèo chấp bóng đá hôm nay duy nhất, định danh được trích kèo chấp bóng đá hôm nay gấp đôi). Nhưng đây là một Vấn đề kỹ thuật ngôn ngữ bên trong mà nhiều người dùng không phải quen thuộc với, nó sẽ không quy mô sang các loại thuật ngữ được trích kèo chấp bóng đá hôm nay khác, nó không dịch sang các ngôn ngữ khác và nó đẹp vô nghĩa, quá.
sử dụng kèo chấp bóng đá hôm nay giá luôn luôn để phân định tên tệp, do người dùng cung cấp Định danh và các biến khác có thể chứa các từ. LÀM 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ẽ tăng gấp đôi
đầu ra của riêng họ khi cần (ví dụ:format_type_be ()). Không đặt bổ sung
kèo chấp bóng đá hôm nay giá xung quanh đầu ra của các chức năng như vậy.
Rationale: Các đối tượng có thể có tên tạo ra sự mơ hồ khi được nhúng trong một tin nhắn. Nhất quán về việc biểu thị nơi một Tên cắm bắt đầu và kết thúc. Nhưng không làm lộn xộn tin nhắn với dấu ngoặc kép không cần thiết hoặc trùng lặp.
Các quy tắc khác nhau cho các kèo chấp bóng đá hôm nay chính và cho Thông điệp chi tiết/gợi ý:
kèo chấp bóng đá hôm nay 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ề kết thúc một tin nhắn với một dấu chấm than.
kèo chấp bóng đá hôm nay đ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 người có 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 chấp bóng đá hôm nay: Không viết hoa chữ cái đầu tiên và không kết thúc chuỗi với một khoảng thời gian. Chuỗi bối cảnh nên bình thường không phải là câu hoàn chỉnh.
Rationale: Tránh dấu câu giúp khách hàng dễ dàng hơn Các ứng dụng để nhúng kèo chấp bóng đá hôm nay điệp vào nhiều loại ngữ pháp khác nhau bối cảnh. kèo chấp bóng đá hôm nay thường, các tin nhắn chính không theo ngữ pháp hoàn thành câu nào. (Và nếu chúng đủ dài để trở thành nhiều hơn một câu, chúng nên được chia thành chính và các phần chi tiết.) Tuy nhiên, kèo chấp bóng đá hôm nay điệp chi tiết và gợi ý dài hơn và Có thể cần phải bao gồm nhiều câu. Cho sự nhất quán, họ nên làm theo phong cách hoàn toàn câu ngay cả khi chỉ có một câu.
Sử dụng chữ thường cho từ ngữ tin nhắn, bao gồm cả bản đầu tiên Thư của một kèo chấp bóng đá hôm nay chính. Sử dụng trường hợp trên cho SQL các lệnh và từ khóa nếu chúng xuất hiện trong tin nhắn.
Đặt vấn đề: dễ dàng hơn để làm cho mọi thứ trông giống hơn phù hợp theo cách này, vì một số tin nhắn là câu hoàn chỉnh và một số không.
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 ("A không thể làm B "). Sử dụng kiểu telegram mà không có chủ đề nếu chủ đề sẽ là chính chương trình; Không sử dụng"I"cho chương trình.
Đặt vấn đề: Chương trình không phải là con người. Đừng giả vờ nếu không thì.
sử dụng thì quá khứ nếu cố gắng làm điều gì đó không thành công, nhưng có lẽ có thể thành công vào lần tới (có lẽ sau khi sửa chữa một số vấn đề). Sử dụng thì hiện tại nếu sự thất bại chắc chắn là Vĩnh viễn.
Có sự khác biệt ngữ nghĩa không cần thiết giữa các câu của biểu mẫu:
Không thể mở tệp " %s": %m
và:
Không thể mở tệp "%s"
17957_18067"Đĩa đầy đủ"hoặc"Tệp không hiện hữu". Thì quá khứ là thích hợp vì lần sau đĩa có thể không còn đầy nữa hoặc tệp được đề cập có thể tồn tại.
Mẫu thứ hai chỉ ra rằng chức năng mở Tệp được đặt tên hoàn toàn không tồn tại trong chương trình hoặc Nó là không thể về mặt khái niệm. Thì hiện tại là thích hợp Vì điều kiện sẽ tồn tại vô thời hạn.
Rationale: Được cấp, người dùng trung bình sẽ không thể rút ra những kết luận tuyệt vời chỉ từ căng thẳng của tin nhắn, Nhưng vì ngôn ngữ cung cấp cho chúng ta một ngữ pháp, chúng ta nên sử dụng nó chính xác.
Khi trích kèo chấp bóng đá hôm nay tên của một đối tượng, hãy nêu loại đối tượng nào nó là.
Đặt vấn đề: Nếu không thì không ai sẽ biết những gì"foo.bar.baz"đề cập đến.
19244_19380
Đặt vấn đề: Bất cứ điều gì khác không tương ứng với được biết đến rộng rãi sử dụng kèo chấp bóng đá hôm nay thường và sẽ gây nhầm lẫn cho mọi người.
Khi một tin nhắn bao gồm văn bản được tạo ở nơi khác, Nhúng nó theo kiểu này:
Không thể mở tệp %s: %m
19820_20182
Tin nhắn phải luôn nêu lý do tại sao một kèo chấp bóng đá hôm nay xảy ra. Ví dụ:
xấu: không thể mở tệp %s Tốt hơn: Không thể mở tệp %s (i/o thất bại)
Nếu không có lý do nào được biết, bạn sẽ sửa mã tốt hơn.
20734_21009
xấu: pg_atoi: kèo chấp bóng đá hôm nay 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 số nguyên: "Z"
Tránh đề cập đến tên chức năng được gọi là; thay vào đó nói Mã đã cố gắng làm gì:
xấu: Open () không thành công: %m Tốt hơn: Không 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 thông điệp chi tiết. (Trong một số trường hợp, cung cấp các giá trị thực tế được chuyển đến cuộc gọi hệ thống có thể là thông tin phù hợp cho kèo chấp bóng đá hôm nay chi tiết.)
Đặt vấn đề: Người dùng không biết tất cả các chức năng đó làm gì.
không thể. "Không thể"IS Gần như giọng nói thụ động. Sử dụng tốt hơn"Không thể"21973_21979"Có thể không", khi thích hợp.
xấu.kèo chấp bóng đá hôm nay như22145_22165thực sự khó diễn giải kèo chấp bóng đá hôm nay minh. Tốt hơn là viết tại sao kết quả là"xấu", ví dụ:"Không hợp lệ định dạng".
bất hợp pháp. "bất hợp pháp"là viết tắt của vi phạm pháp luật, phần còn lại là"không hợp lệ". Tốt hơn nữa, hãy nói tại sao nó không hợp lệ.
không xác định.cố gắng tránh"Không xác định". Coi như"kèo chấp bóng đá hôm nay: phản hồi không xác định". Nếu bạn không biết Phản hồi là gì, làm thế nào để bạn biết nó sai?"không được nhận dạng"thường là tốt hơn sự lựa chọn. Ngoài ra, hãy chắc chắn bao gồm giá trị bị phàn nàn của.
xấu: loại nút không xác định Tốt hơn: Loại nút không được công nhận: 42
Tìm so với tồn tại.Nếu chương trình sử dụng không cần thiết Thuật toán để định vị một tài nguyên (ví dụ: tìm kiếm đường kèo chấp bóng đá hôm nay) và cái đó Thuật toán thất bại, thật công bằng khi nói rằng chương trình không thể"Tìm"Tài nguyên. Nếu, trên mặt khác, vị trí dự kiến của tài nguyên được biết đến Nhưng chương trình không thể truy cập nó ở đó sau đó nói rằng Tài nguyên không"tồn tại". Sử dụng"Tìm"Trong trường hợp này nghe có vẻ yếu và nhầm lẫn vấn đề.
Có thể so với có thể so với Might. "May"đề xuất sự cho phép (ví dụ: "bạn có thể mượn cái cào của tôi. "), và ít sử dụng trong tài liệu hoặc kèo chấp bóng đá hôm nay."CAN"Đề xuất khả năng (ví dụ: "Tôi có thể nâng nhật ký đó.") và"Might"đề xuất khả năng (ví dụ: "nó 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ư"Không thể"; sử dụng"Không thể"thay vào đó.
đánh vần các từ đầy đủ. Chẳng hạn, tránh:
spec
Số liệu thống kê
Parens
auth
XACT
Đặ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 chấp bóng đá hôm nay cần được dịch vào các ngôn ngữ khác. Thực hiện theo các hướng dẫn trongPhần 48.2.2đến Tránh làm cho cuộc sống khó khăn cho các dịch giả.