Tôi không thể tìm cách viết nhận xét bằng C. Ý tôi là tôi biết về // và /* */, ý tôi là tôi có thể tìm các phương pháp hay ở đâu? Giống như nếu tôi có một chức năng, làm thế nào để viết @param variable is the value bla bla, giống như nó được thực hiện trong Java?Làm thế nào để viết ý kiến tài liệu trong ANSI C?
Có bất kỳ tiêu chuẩn nào cho điều này không? Hoặc tôi có thể làm điều đó giống như tôi làm điều đó trong Java?
Có rất nhiều tiêu chuẩn khác nhau, nếu bạn muốn tạo tài liệu, hãy thử doxygen
Không có tiêu chuẩn theo các tiêu chuẩn mà nhiệm vụ công ty bạn.
Cách phổ biến để tạo tài liệu từ dự án là sử dụng Doxygen.
Một tùy chọn là sử dụng định dạng doxygen để viết nhận xét - điều này có lợi ích bổ sung khi có thể tạo html/latex và các loại tài liệu khác cho mã của bạn.
Bạn có thể sử dụng tiêu chuẩn javadoc và sau đó sử dụng doxygen để hiểu javadoc để tạo tài liệu.
Trong doxygen Tôi khuyên bạn nên sử dụng tùy chọn JAVADOC_AUTOBRIEF đặt thành YES. Nếu thẻ JAVADOC_AUTOBRIEF được đặt thành YES thì doxygen sẽ giải thích dòng đầu tiên (cho đến dấu chấm đầu tiên) của một chú thích kiểu Javadoc là mô tả ngắn gọn.
Ví dụ cho một định nghĩa lớp:
/**
* A brief description. A more elaborate class description
* @param bool somebool a boolean argument.
* @see Test()
* @return The test results
*/
(Một số ví dụ khác in the doxygen manual)
Cài đặt rất đơn giản, có một giao diện đồ họa và trực quan đồ họa đẹp sẵn có:
apt-get install doxygen doxygen-gui graphviz
Chạy gui gọi doxywizard và sử dụng cài đặt Thuật sĩ, chỉ JAVADOC_AUTOBRIEF phải được đặt ở đó trong thanh toán "Chuyên gia" ings.
Câu trả lời hay với ví dụ. – Drew
Thực ra, bạn thậm chí không thể sử dụng '//' trong ANSI C. Chỉ từ C99 chúng mới cho phép '//'. (Mặc dù GCC cho phép nó như là một phần mở rộng.) – Mysticial
Chỉ '/ * * /' được hỗ trợ trong C. '//' là một bổ sung trong C++ –
Thuật ngữ "ANSI C" thường đề cập đến ngôn ngữ được mô tả bởi tiêu chuẩn ANSI 1989 , nhưng nói đúng là không đúng. Năm 1990, ISO đã ban hành cùng một tiêu chuẩn (với một số tài liệu giới thiệu mới và các phần đã được đổi màu), và ANSI đã thông qua nó. Năm 1999, ISO đã ban hành một tiêu chuẩn C mới, và ANSI đã chấp nhận nó, làm cho tiêu chuẩn 1989/1990 chính thức lỗi thời. Vào cuối năm 2011, ISO đã ban hành một tiêu chuẩn C mới, mà ANSI cũng đã thông qua. Ngoại trừ các tiêu chuẩn đầu tiên, C ban đầu được xuất bản bởi ISO, chứ không phải ANSI - và tốt nhất là nên tham khảo các tiêu chuẩn theo năm. –