is "!" also used for documentation purpose?


 
Thread Tools Search this Thread
Top Forums UNIX for Dummies Questions & Answers is "!" also used for documentation purpose?
# 1  
Old 12-13-2011
is "!" also used for documentation purpose?

is
Code:
!

also used for documentation/multi line comment purpose in unix shell scripting?
# 2  
Old 12-13-2011
Not really, no.
This User Gave Thanks to Corona688 For This Post:
# 3  
Old 12-13-2011
Strange question. In your previous thread you were using ! as the terminator for Here Documents in Shell.

I believe ! is a comment in HTML and XML .
# 4  
Old 12-14-2011
"
(Originally posted by methyl)
Problem was the two lines like this:

Code:
!
Because they were not in column 1, all the lines from the <<! to the next line which did properly start with ! were treated as part of the Here Document. Thus most of your code did not execute (and that includes the "elif" line)."

Yes methyl, As per you response only I felt that by using ! can be used for documentation purpose... does it means it need to have
Code:
<<!

&
Code:
!

?

Because usually whenever I write a code in shell I face this problem that few part of my code get documented and it lost control Smilie
# 5  
Old 12-14-2011
If I understand you correctly. There is no multi-line documentation symbol in unix Shell (unlike some programming languages). Anything from a hash sign onwards on the same line is comment.

Code:
#The documentation sign in unix Shell script is a hash
# Like this
# And this
#
ls -lad    # This command produces a directory listing
#
# The next line produces a directory listing
ls -lad

This User Gave Thanks to methyl For This Post:
# 6  
Old 12-14-2011
By 'documentation purposes' do you mean for a here document?

In theory, you can use almost any string as the delimiter, but normally you'll see 'EOF' or 'EOD'. '!' would be a slightly odd choice though, as it's often a special shell character.

The important thing is that the delimiter string has to be the first thing on the line (with no preceding whitespace) in order to terminate the heredoc.
These 2 Users Gave Thanks to CarloM For This Post:
# 7  
Old 12-14-2011
Good thinking CarloM.

I've seen ! used as the terminator for a Here Document in an old Shell Tutorial book. Maybe that is why it is so common.
As you say, most people prefer EOF or EOD . We have system scripts containing many variants - including ==end_of_command== .
I used to use **** because it was the standard terminator for a punched card reader.
 
Login or Register to Ask a Question

Previous Thread | Next Thread

9 More Discussions You Might Find Interesting

1. AIX

Apache 2.4 directory cannot display "Last modified" "Size" "Description"

Hi 2 all, i have had AIX 7.2 :/# /usr/IBMAHS/bin/apachectl -v Server version: Apache/2.4.12 (Unix) Server built: May 25 2015 04:58:27 :/#:/# /usr/IBMAHS/bin/apachectl -M Loaded Modules: core_module (static) so_module (static) http_module (static) mpm_worker_module (static) ... (3 Replies)
Discussion started by: penchev
3 Replies

2. Shell Programming and Scripting

Bash script - Print an ascii file using specific font "Latin Modern Mono 12" "regular" "9"

Hello. System : opensuse leap 42.3 I have a bash script that build a text file. I would like the last command doing : print_cmd -o page-left=43 -o page-right=22 -o page-top=28 -o page-bottom=43 -o font=LatinModernMono12:regular:9 some_file.txt where : print_cmd ::= some printing... (1 Reply)
Discussion started by: jcdole
1 Replies

3. UNIX for Dummies Questions & Answers

Using "mailx" command to read "to" and "cc" email addreses from input file

How to use "mailx" command to do e-mail reading the input file containing email address, where column 1 has name and column 2 containing “To” e-mail address and column 3 contains “cc” e-mail address to include with same email. Sample input file, email.txt Below is an sample code where... (2 Replies)
Discussion started by: asjaiswal
2 Replies

4. Shell Programming and Scripting

What is the purpose of "-z" string checking?

what is the purpose of below specially "-z" string checking, how? pid=`ps ax |grep java` if (3 Replies)
Discussion started by: learnbash
3 Replies

5. Shell Programming and Scripting

how to use "cut" or "awk" or "sed" to remove a string

logs: "/home/abc/public_html/index.php" "/home/abc/public_html/index.php" "/home/xyz/public_html/index.php" "/home/xyz/public_html/index.php" "/home/xyz/public_html/index.php" how to use "cut" or "awk" or "sed" to get the following result: abc abc xyz xyz xyz (8 Replies)
Discussion started by: timmywong
8 Replies

6. Shell Programming and Scripting

Purpose of "read" and "$END$" in ksh ?

Hi, Could anyone please shed some light on the following script lines and what is it doing as it was written by an ex-administrator? cat $AMS/version|read a b verno d DBVer=$(/usr/bin/printf "%7s" $verno) I checked that the cat $AMS/version command returns following output: ... (10 Replies)
Discussion started by: dbadmin100
10 Replies

7. Shell Programming and Scripting

awk command to replace ";" with "|" and ""|" at diferent places in line of file

Hi, I have line in input file as below: 3G_CENTRAL;INDONESIA_(M)_TELKOMSEL;SPECIAL_WORLD_GRP_7_FA_2_TELKOMSEL My expected output for line in the file must be : "1-Radon1-cMOC_deg"|"LDIndex"|"3G_CENTRAL|INDONESIA_(M)_TELKOMSEL"|LAST|"SPECIAL_WORLD_GRP_7_FA_2_TELKOMSEL" Can someone... (7 Replies)
Discussion started by: shis100
7 Replies

8. Shell Programming and Scripting

cat $como_file | awk /^~/'{print $1","$2","$3","$4}' | sed -e 's/~//g'

hi All, cat file_name | awk /^~/'{print $1","$2","$3","$4}' | sed -e 's/~//g' Can this be done by using sed or awk alone (4 Replies)
Discussion started by: harshakusam
4 Replies

9. UNIX for Dummies Questions & Answers

Explain the line "mn_code=`env|grep "..mn"|awk -F"=" '{print $2}'`"

Hi Friends, Can any of you explain me about the below line of code? mn_code=`env|grep "..mn"|awk -F"=" '{print $2}'` Im not able to understand, what exactly it is doing :confused: Any help would be useful for me. Lokesha (4 Replies)
Discussion started by: Lokesha
4 Replies
Login or Register to Ask a Question