kèo bóng đá pháp trang tham chiếu phải tuân theo bố cục tiêu chuẩn. Điều này cho phép người dùng tìm thấy thông tin mong muốn nhanh chóng hơn và nó cũng khuyến khích kèo bóng đá pháp nhà văn ghi lại tất cả kèo bóng đá pháp khía cạnh liên quan của một lệnh. Tính nhất quán không chỉ mong muốn giữaPostgreSQLCác trang tham chiếu, nhưng cũng với các trang tham chiếu được cung cấp bởi hệ điều hành và các gói khác. Do đó các hướng kèo bóng đá pháp sau đây đã được phát triển. Chúng là phần lớn phù hợp với các hướng kèo bóng đá pháp tương tự được thiết lập bởi các hệ điều hành khác nhau.
kèo bóng đá pháp trang tham chiếu mô tả kèo bóng đá pháp lệnh thực thi phải chứa kèo bóng đá pháp phần sau, theo thứ tự này. kèo bóng đá pháp phần không áp dụng có thể được bỏ qua. kèo bóng đá pháp phần cấp cao hơn chỉ nên được sử dụng trong kèo bóng đá pháp trường hợp đặc biệt; Thường thì thông tin đó thuộc vềHồisử dụng”Phần.
Phần này được tạo tự động. Nó chứa tên lệnh và tóm tắt nửa câu của chức năng của nó.
Phần này chứa sơ đồ cú pháp của lệnh. Tóm tắt thường không liệt kê từng tùy chọn dòng lệnh; Điều đó được thực hiện dưới đây. Thay vào đó, hãy liệt kê kèo bóng đá pháp thành phần chính của dòng lệnh, chẳng hạn như nơi kèo bóng đá pháp tệp đầu vào và đầu ra đi.
Một số đoạn giải thích lệnh làm gì.
Một danh sách mô tả từng tùy chọn dòng lệnh. Nếu có nhiều tùy chọn, kèo bóng đá pháp tiểu mục có thể được sử dụng.
Nếu chương trình sử dụng 0 để thành công và không phải cho thất bại, thì bạn không cần phải ghi lại nó. Nếu có một ý nghĩa đằng sau kèo bóng đá pháp mã thoát khác không khác nhau, hãy liệt kê chúng ở đây.
Mô tả bất kỳ giao diện phụ hoặc thời gian chạy của chương trình. Nếu chương trình không tương tác, phần này thường có thể được bỏ qua. Mặt khác, phần này là một tất cả để mô tả kèo bóng đá pháp tính năng thời gian chạy. Sử dụng kèo bóng đá pháp tiểu mục nếu thích hợp.
Liệt kê tất cả kèo bóng đá pháp biến môi trường mà chương trình có thể sử dụng. Cố gắng hoàn thành; Thậm chí có vẻ là những biến số tầm thường nhưshellCó thể được người dùng quan tâm.
Liệt kê bất kỳ tệp nào mà chương trình có thể truy cập ngầm. Nghĩa là, không liệt kê kèo bóng đá pháp tệp đầu vào và đầu ra được chỉ định trên dòng lệnh, nhưng liệt kê kèo bóng đá pháp tệp cấu hình, v.v.
Giải thích bất kỳ đầu ra bất thường nào mà chương trình có thể tạo. Tránh liệt kê mọi thông báo lỗi có thể. Đây là rất nhiều công việc và ít sử dụng trong thực tế. Nhưng nếu, giả sử, kèo bóng đá pháp thông báo lỗi có định dạng tiêu chuẩn mà người dùng có thể phân tích, đây sẽ là nơi để giải thích nó.
Bất cứ điều gì không phù hợp ở nơi khác, nhưng cụ thể là kèo bóng đá pháp lỗi, lỗ hổng thực hiện, cân nhắc bảo mật, kèo bóng đá pháp vấn đề tương thích.
ví dụ
Nếu có một số cột mốc chính trong lịch sử của chương trình, chúng có thể được liệt kê ở đây. Thông thường, phần này có thể được bỏ qua.
tác giả (chỉ được sử dụng trong phần đóng góp)
Tham khảo chéo, được liệt kê theo thứ tự sau: KhácPostgreSQLTrang tham chiếu lệnh,PostgreSQLTrang tham chiếu lệnh SQL, trích kèo bóng đá phápPostgreSQLHướng kèo bóng đá pháp sử dụng, các trang tham chiếu khác (ví dụ: hệ điều hành, các gói khác), tài liệu khác. Các mục trong cùng một nhóm được liệt kê theo thứ tự bảng chữ cái.
16516_17191
Nếu bạn thấy bất cứ điều gì trong tài liệu không chính xác, không phù hợp Kinh nghiệm của bạn với tính năng cụ thể hoặc yêu cầu làm rõ thêm, Vui lòng sử dụngMẫu nàyĐể báo cáo vấn đề tài liệu.