Emacs लिस्प संदर्भ मैनुअल के परिशिष्ट D.7 में कुछ टिप्पणी युक्तियों का उल्लेख है:
;इनलाइन टिप्पणियों के लिए एकल अर्धविराम ( ) का उपयोग किया जाना चाहिए।- डबल अर्धविराम (
;;) का उपयोग लाइन टिप्पणियों के लिए किया जाना चाहिए। - ट्रिपल अर्धविराम (
;;;) का उपयोग "टिप्पणियों के लिए किया जाना चाहिए जिसे आउटलाइन माइनर मोड द्वारा शीर्षक माना जाना चाहिए"। ;;;;एक कार्यक्रम के प्रमुख वर्गों के शीर्षकों के लिए चौगुनी अर्धविराम ( ) का उपयोग किया जाना चाहिए।
एकल और डबल अर्धविराम उपयोग के मामले स्पष्ट हैं, लेकिन ट्रिपल और चौगुनी अर्धविराम के बीच एक तेज परिसीमन प्रतीत नहीं होता है।
विशेष रूप से, 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
ट्रिपल और चौगुनी अर्धविराम के लिए सर्वोत्तम अभ्यास क्या हैं?
अपडेट करें
स्टीफन के जवाब के लिए धन्यवाद , मैंने एक बग रिपोर्ट दर्ज की है और निम्नलिखित सुझाव दिया है:
मेरा सुझाव है कि तीन अर्धविरामों के विवरण को निम्न में बदल दिया जाए:
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
चार अर्धविरामों के लिए अनुभाग को समाप्त किया जा सकता है।
grep -r '^;;;; ' lispप्रेरणा के लिए Emacs स्रोतों ( ) के माध्यम से देखें ।