Emacs Lisp แบบแผนข้อคิดเห็น

ภาคผนวก D.7คู่มืออ้างอิงของ Emacs Lisp กล่าวถึงเคล็ดลับความคิดเห็น:

• ;ควรใช้เซมิโคลอนเดี่ยว ( ) สำหรับความคิดเห็นแบบอินไลน์
• ;;ควรใช้เครื่องหมายอัฒภาคคู่ ( ) เพื่อแสดงความคิดเห็นในบรรทัด
• ;;;ควรใช้เครื่องหมายอัฒภาค ( ) สำหรับ "ความคิดเห็นซึ่งควรพิจารณาหัวข้อโดยใช้โหมดย่อย"
• ;;;;ควรใช้เซมิโคลอนสี่ส่วน ( ) สำหรับส่วนหัวของส่วนสำคัญของโปรแกรม

กรณีการใช้เครื่องหมายอัฒภาคเดี่ยวและคู่นั้นชัดเจน แต่ดูเหมือนจะไม่มีการแบ่งแยกที่ชัดเจนระหว่างอัฒภาคสามและสี่เท่า

โดยเฉพาะอย่างยิ่งเอกสารมาตรฐานสำหรับแพ็คเกจ Emacs ที่จัดทำโดยauto-insertใช้เครื่องหมายอัฒภาคสามตัวไม่ใช้เครื่องหมายอัฒภาคสี่เท่าแม้กระทั่งหัวเรื่องระดับสูงสุดเช่นชื่อไฟล์และส่วนสำคัญ ดูตัวอย่างด้านล่าง:

;;; test.el --- A test file.                         -*- lexical-binding: t; -*-

;; Copyright (C) 2016

;; Author:  John Smith
;; Keywords: 

;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with this program.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:

;; 

;;; Code:



(provide 'test)
;;; test.el ends here

อะไรคือวิธีปฏิบัติที่ดีที่สุดสำหรับอัฒภาคสามและสี่เท่า?

ปรับปรุง

ขอบคุณคำตอบของ Stefanฉันได้ยื่นรายงานข้อผิดพลาดและทำข้อเสนอแนะต่อไปนี้:

ฉันขอแนะนำให้เปลี่ยนคำอธิบายสำหรับสามอัฒภาคเป็น:

Comments that start with three semicolons, ‘;;;’, are considered
top-level headings by Outline minor mode.

Four or more semicolons can be used as subheadings in hierarchical
fashion. E.g.

;;; Main heading
;;;; Sub heading
;;;;; Sub sub heading
;;;; Another sub heading
;;; Next main heading

These comments should be used to break Emacs Lisp code into sections.

ลิงก์ไปยัง "สรุปโหมดรอง" ในคู่มือ Emacs จะเป็นประโยชน์: https://www.gnu.org/software/emacs/manual/html_node/emacs/Outline-Mode.html

ส่วนสำหรับสี่อัฒภาคสามารถ elided

ที่จริงแล้วเซมิโคลอน 3 ตัวและมากกว่านั้นยืนสำหรับส่วนหัวซึ่งคุณจะต้องวางรังของส่วนหัวให้มากขึ้น ดังนั้นควรมีลักษณะดังนี้

;;; Main heading
;;;; Sub heading
;;;;; Sub sub heading
;;;; Another sub heading
;;; Next main heading