कैसे उपयोग करने के लिए टिप्पणी में पर्ल कोड

प्रोग्राम कोड के द्वारा मार डाला है एक कंप्यूटर है । लेकिन मैं इस कोड लिखने के लिए और लोगों के पूरक हैं. कंप्यूटर में अब भी है के रूप में जटिल और जटिल कोड — यह सिर्फ प्रदर्शन करेंगे. लेकिन अगर कोड आसान करने के लिए समझने के लिए, यह आसान हो जाएगा और तेजी से पूरा करने के लिए और यह होगा कम गलतियाँ.

टिप्पणी में कार्यक्रम के पाठ का इरादा मानव उपयोग के लिए. कंप्यूटर का उपयोग नहीं करता है टिप्पणियाँ. उद्देश्य की समीक्षा करने के लिए कोड बनाने के लिए स्पष्ट मानव. टिप्पणी सभी समय कार्यक्रम में कोड की, जब एक व्यक्ति की जरूरत है बदलने के लिए कोड का टुकड़ा है, इसे पढ़ता है की समीक्षा करने और है वह सरल की समझ में क्या हो रहा है कोड.

दूसरा उद्देश्य की समीक्षा एक उपकरण है जब विकास कोड. अक्सर कोड लिखने वहाँ एक टुकड़ा है जो आवश्यक नहीं है, लेकिन बहुत जल्द ही आप की आवश्यकता होगी. इस मामले में, टुकड़ा यह सुविधाजनक है करने के लिए बाहर टिप्पणी कोड जब तक चलाने के लिए-डिबग कोड । जब काम समाप्त होता है इन बाहर टिप्पणी कोड के टुकड़े नहीं रहना चाहिए.

एकल लाइन टिप्पणी

लिखने के लिए एक टिप्पणी में पर्ल प्रोग्रामिंग भाषा की जरूरत है आप के लिए डाल पाउंड #. इस के बाद सब कुछ प्रतीक करने के लिए लाइन का अंत हो जाएगा एक टिप्पणी है ।

प्रतीक सरणी हो सकता है पर लाइन की शुरुआत:

# This is a comment
my @arr = (1..10);

या के सामने जंगला किया जा सकता है अंतराल:

foreach my $el (@arr) {
    # One more comment
    warn $el;
}

और समीक्षा के बाद जा सकते हैं कोड:

my @arr = (1, 2, 3); # some description for @arr
my %h; # explanation of %h

की समीक्षा कर सकते हैं करने के लिए लिखने के तुरंत बाद पौंड प्रतीक है, लेकिन पठनीयता के लिए आप डाल दिया जाना चाहिए के बाद एक अंतरिक्ष #

#comment without a space
# comment with a space

अगर हैश के अंदर है, स्ट्रिंग है, यह नहीं है, एक समीक्षा के भाग के रूप में एक स्ट्रिंग:

my $str = 'Line 1
# This is not a comment, but part of a string variable
Line 2';

विन्यास संपादक

जब वहाँ है एक सक्रिय परियोजना पर काम वहाँ एक की जरूरत है, टिप्पणी करने के लिए कई कोड की लाइनों.

यह बहुत सुविधाजनक है को कॉन्फ़िगर करने के लिए पाठ संपादक के लिए हो सकता है के रूप में आसान के रूप में संभव है. उदाहरण के लिए बनाने के लिए संपादक को इस तरह से काम:

  • हाइलाइट सभी लाइनों आप चाहते हैं टिप्पणी करने के लिए बाहर
  • क्लिक करें Ctrl+/
  • परिणाम सभी के सामने लाइनों थे जो चयनित प्रतीक प्रकट होता है #

बहु-रेखा टिप्पणियाँ

कोड में पर्ल प्रोग्राम लिखा जा सकता है प्रलेखन. यह का उपयोग करता है एक विशेष मार्कअप भाषा फली (यह खड़ा है के लिए सादे पुराने दस्तावेज). फली विशेष रूप से डिजाइन करने के लिए करने के लिए पाठ लिखने के लिए इंसानों में प्रोग्राम कोड.

यहाँ एक उदाहरण फली मार्कअप प्रलेखन के लिए विधि के बारे में:

=head2 get_name

    my $name = $obj->get_name();

Returns the name of the Person stored in the object.

The return value is a scalar with length >= 1 and <= 100.

=cut

sub get_name {
    my ($self, @other) = @_;

    die 'get_name should not get any parameters' if @other;

    return $self->{_name};
}

फली मार्कअप हमेशा शुरू होता है के साथ बराबर =, जिसके बाद कोई जगह नहीं है निर्देश. उदाहरण के लिए =head2 या =item. प्रतीक = हमेशा होना चाहिए की शुरुआत में एक पंक्ति में हैं. अगर वह होगा रिक्त स्थान है, यह काम नहीं करेगा.

फली मार्कअप हमेशा के लिए समाप्त होता है के साथ एक निर्देशक =cut. और इससे पहले कि चरित्र = भी अंतराल नहीं होना चाहिए ।

उपयोग बहु टिप्पणी के लिए अस्थायी रूप से हटाने के कोड

यदि आप एक परियोजना पर काम आप की आवश्यकता होगी करने के लिए अस्थायी रूप से बाहर टिप्पणी कोड का एक टुकड़ा के लिए इस आप इस तकनीक का उपयोग करें. कोड के पहले आप चाहते हैं टिप्पणी करने के लिए आप की जरूरत लिखने के लिए =a, और कोड के बाद =cut:

my $str = 'AB';

=a
foreach my $el (1..10) {
    parse_index($el);
}
=cut

लिखा है कि सभी के बीच =a और =cut से छिपा हो जाएगा पर्ल इंटरप्रेटर.

लेकिन यह है कि एक निर्णय नहीं किया जा सकता है में छोड़ दिया प्रोग्राम कोड. =a मान्य नहीं है फली निर्देश और विभिन्न फली पारसर्स दे देंगे त्रुटियों के साथ कार्य करते समय कोड शामिल है, जो इस तरह के गलत फली.

अन्य लेख