Comments on Code

Hi guys,
I'm a 2 weeks of simple DAQ + 1 month forums self taught labview user and I'm working on a rather large control application.
Before I continue, I think I've produced a pretty large chunk of one of the components of my application - it is responsible for controlling the motors.
I want to make sure it's robust and uses good style.
Can anyone out there can quickly point out some stylistic errors? Don't waste your time on this if you're busy - just do it for fun.
Notes:
--> The references come from 1 main VI file which uses CTR SET.
--> I have used a VI template since I would like to call this function 4 times - for 4 different motors with a different Axis (or Address).
--> I'm still pretty confused about the events node - in that I can't seem to figure out a way to get an event to trigger when a reference value changes. Signalling triggers on every write - which is not my intended purpose.
--> Also, I haven't yet tested the queues, nor have I ever used queues before, labview help just got me through it.
--> This is 1 VI that calls a few SUB Vi's, some of them extremely simple, others that are a few layers deep. All of the SUB Vis do not use references, events or anything of the sort, they are simple data flow and loops to iterate code in a structured maner (setting data up in a readable format, read write, etc etc)
I'm worried I just have bad style or am doing certain things that can cause fatal errors.
Thanks!
PS: I remember Altenbach giving me a bunch of tips earlier on my code - it really helped push me forward.
Solved!
Go to Solution.
Attachments:
Top.png ‏48 KB
Middle.png ‏38 KB
Bottom.png ‏55 KB

pierroil wrote:
Why is it neccesary to have space? I mean, I take it for granted they are connected if they are in contact.
In my experience, you can't take anything for granted.
As far as the bundle and unbundling is concerned, always bundle by name and you can get away with something like the following. Notice that you don't need to wire everything straight through. Only the values you are specifically bundling will be overwritten in the cluster. I also showed the alternative of using the Inplace Element Structure, which seems more intuitive to me.
There are only two ways to tell somebody thanks: Kudos and Marked Solutions
Unofficial Forum Rules and Guidelines
Attachments:
Bundle Examples.png ‏17 KB

Similar Messages

Comment out code in Update Rule

Hello,
Quick question.
How do I comment out code in the update rule? I need to comment out a large amount of code for testing purposes.
Thanks,
Sheila

Hi Sheila
Go to Update rule code (routine) ->> select the code you want to comment out with mouse ->> then go to top menu Utilities -> Block/Buffer-> Insert Comment *
This will comment out the code that you had selected.
Regards
Pradip
(don't forget points)

Commenting out code in TrueCode mode deletes code

We used RoboHelp X3 and was trying to comment out specific
sections of a code by moving over to the True Code view and
commenting them out following the usual HTML standards/conventions.
However, we found that when we saved the project, generated the
file, and opened the topic(s) from the source project next time,
the sections that we had commented out had actually got deleted.
Could you please help me with this? Is there a specific way to
comment out code in RoboHelp?

(I began the earlier reply before I knew what I wanted to
say).
Is it possible that when those particular lines are commented
out, the result is a syntax error in the remaining html or js code?
Also, consider that html and js code techniques have come a
long way since X3. Maybe your code is technically correct now, but
X3 doesn't know it.
Good luck.
Harvey

[svn:fx-trunk] 10065: Comment out code causing an RTE in SWFLoader.

Revision: 10065
Author:   [email protected]
Date:     2009-09-08 13:14:26 -0700 (Tue, 08 Sep 2009)
Log Message:
Comment out code causing an RTE in SWFLoader. Will fix as part of per-module styles feature development.
QE notes: None.
Doc notes: None.
Bugs: SDK-23081
Reviewer:
Tests run: checkintests
Is noteworthy for integration: no
Ticket Links:
    http://bugs.adobe.com/jira/browse/SDK-23081
Modified Paths:
    flex/sdk/trunk/frameworks/projects/framework/src/mx/controls/SWFLoader.as

Hello, first post here..
I maintain a java based lobby for an opensource RTS
engine called spring at http://taspring.clan-sy.com
You can find my lobbys source code at:
https://taspring.clan-sy.com/svn/spring/trunk/AFLobby/
Of note being the unitsync.dll/so library used to
handle mods and maps. Implementing this library in
pure java is not an option.
I've dealt with quite a few JNi errors dealing with
the linux users but we got through them all and it
all worked great.
I released a windows installer, and most users can
run it fine with no issues with JNI, but 2 users seem
to have problems, despite correctly installing
everything.Does the JNI code use perl?
This error message shows several hits on Google for perl related stuff.

How to export selected comments thru code

Hi,
Is there any api by which we can export selected/some comments thru code. As exportAsFDF exports all the comments of the document.
Regards,
Arvind

I believe there are plugin Apis for serializing a subset of comments. Also in Javascript
Sent from my iPad

Why web dynpro commented my code out?

Hi All,
<b>as i tried to save the code for a method i have written in a view.java. the web dynpro comment my code out. and gives me the following message:</b>
The following code section can be used for any Java code that is
not to be visible to other controllers/views or that contains constructs
currently not supported directly by Web Dynpro (such as inner classes or
member variables etc.). </p>
Note: The content of this section is in no way managed/controlled
by the Web Dynpro Designtime or the Web Dynpro Runtime.
<b>i have had this problem couple of times already. sometimes i just needed to try one more time, it worked fine again. i just lose my patient to type the code again and again...
does anybody know wwhat's wrong?</b>
thanks!

Hi guys,
the webdypro has sometimes my code commented out and sometimes complete thrown away. so i guess i the problem is that i didn't pay attention to the UCA and code had errors.
now i tried it again, i have no problem any more.
thank you all!
Ting

Image trouble in application + comments on code ?

I have tried to insert an image in this slowly-becoming application but it won't work.
I have commented the parts that don't work (the paint method).
The error only occurs when I un-comment the Paint-method.
It would also be great if you would like to give some comments on my code, this is my first 'project' and I'm going to be grateful for any feedback.
thanks,
David
Here's my code:
import java.awt.*;
import java.awt.image.*;
import java.awt.event.*;
import javax.swing.*;
import java.awt.Toolkit;
public class MainWindow {
public JFrame frame;
public Image img;
     public MainWindow() {
          frame = new JFrame("App. Title here");
          frame.setResizable(false);
          frame.setSize(620,420);
          frame.setBackground(Color.white);
          frame.setDefaultCloseOperation(frame.EXIT_ON_CLOSE);
          JPanel panel = new JPanel();
          Font font = new Font("Verdana", Font.BOLD, 12);
          JLabel heading = new JLabel("Application Heading");
          heading.setFont(font);
          heading.setBackground(Color.white);
          heading.setOpaque(true);
          img = Toolkit.getDefaultToolkit().getImage("image.jpg");
          buildMenu();
          panel.add(heading);
          frame.setContentPane(panel);
          frame.setVisible(true);
     public void buildMenu() {
          JMenuBar mb = new JMenuBar();
          JMenu menu = new JMenu("File");
          JMenuItem item = new JMenuItem("Exit");
          //Closes the application from the Exit menu item.
          item.addActionListener(new ActionListener() {
               public void actionPerformed(ActionEvent e) {
                    System.exit(0);
          menu.add(item);
          mb.add(menu);
          frame.setJMenuBar(mb);
     public static void main(String[] args) {
          try {
               UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
          catch (Exception err) {
               System.out.println("Error loading Look & Feel: "+ err);
          MainWindow SplashScreen = new MainWindow();
     public void paint(Graphics g) {
          g.drawImage(img, 4, 20, this);
}

Thanks for your reply, but another problem has occured.
The image shows up now, which is great, but the menu doesn't ? I have tried to find the problem with no luck.
Here's my code:
many thanks,
David
import java.awt.*;
import java.awt.image.*;
import java.awt.event.*;
import javax.swing.*;
import java.awt.Toolkit;
public class MainWindow_new extends JFrame { // JWindow for splashScreen
public JFrame frame;
public Image img;
     public MainWindow_new() {
          super("App. Title here");
          setResizable(false);
          setSize(620,420);
          setBackground(Color.white);
          setDefaultCloseOperation(frame.EXIT_ON_CLOSE);
          JPanel panel = new JPanel();
          Font font = new Font("Verdana", Font.BOLD, 12);
          MediaTracker tracker = new MediaTracker(this);
          img = Toolkit.getDefaultToolkit().getImage("images\\jpgs\\arena.jpg");
          try {
               tracker.addImage(img, 0);
               tracker.waitForID(0);
          catch (InterruptedException err) {
               System.out.println("MediaTracker Interrupted");
               err.printStackTrace();
          buildMenu();
          setContentPane(panel);
          setVisible(true);
     public void buildMenu() { // Opens buildMenu method definition
          JMenuBar mb = new JMenuBar();
          JMenu menu = new JMenu("File");
          JMenuItem NewItem = new JMenuItem("New Game");
          JMenuItem LoadItem = new JMenuItem("Load Game");
          JMenuItem ExitItem = new JMenuItem("Exit");
          //Closes the application from the Exit menu item.
          ExitItem.addActionListener(new ActionListener() { // Opens addActionListener method
               public void actionPerformed(ActionEvent e) { // Opens actionPerformed method
                    System.exit(0);
          menu.add(NewItem);
          menu.add(LoadItem);
          menu.addSeparator();
          menu.add(ExitItem);
          mb.add(menu);
          setJMenuBar(mb);
     public static void main(String[] args) {
          try {
               UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
          catch (Exception err) {
               System.out.println("Error loading Look & Feel: "+ err);
          MainWindow_new mainWindow = new MainWindow_new();
     public void paint(Graphics g) {
          g.drawImage(img,10,10,this);
}

Commenting JSTL code

Hello,
Can anybody help me out how to comment my JSTL codes in a jsp page?
Thank you,
addiaabeba
:14:15

Hello,
Many thanks for your response. I tried both but the resulting page( after parsing) will have  and my documentation in the source of the document. I want the documentation to be seen only from the server side.
Thanks,
:14:15

What's a good "comment" application/code?

Will be needing a comment section on a web page, where ppl can submit comments. Would like a "simple" version where anyone can post, as well perhaps another requiring either a credential (id number etc.) or pre/review the post prior to it posting. As far as displaying, either propagate the comments down below the content, or maybe have a separate page for viewing (similar to many of the news sites etc.).
Thx

Hi
Yes, it does come up frequently on various forums, but people do not often reply as it does require a knowledge of a server-side language and database code.
(You could look at this - http://www.cellbiol.com/scripts/free_php_guestbook/free_php_guestbook.html).
Basically you would require your comment form to send the info to a database and then be included in your page using the sql WHERE clause to decide if the comment should be included depending on if you wish to 'approve' the inclusion or not.
PZ
www.pziecina.com

Novice window/View question (fixed) -- please comment on code

(fixed this to look right, thanks for the posting tip)
Hey, I am using the iPhone SDK, and this is my first non-licensing question, which means it's going to be a very basic one.
I'm able to start a project, using a ViewController template, edit the XIB file, and then have those controls show up. I'm able to create outlets and inlets and handle user input and output to those controls, all well and good.
Where I'm getting hung up is when I want more than one view. I've read the "how to use the ViewController" documentation, which is more like a "how to" guide for specific subclasses.
All I want to do, for now, is to create two views and swap back and forth between two views. My strategy was to create a parent view (just a container), then create two viewcontrollers (with their views) and then set both their views to the addSubView function of my parent view. Then I was going to use the bringSubviewToFront method to swap between the two, if all goes well then using different animations.
So I did the below in my DidFinishLaunching event handler. All I get is a white screen. Can someone correct my code below, given the intent above? I would learn a TON from the answer, I'd be on my way.
Thanks very much in advance.
- (void)applicationDidFinishLaunching:(UIApplication *)application {
UIView *v = [UIView alloc];
m_pParentView = v; // declared in class interface as UIView *m_pParentView;
ViewCtrlSub1 *vcs1 = [ViewCtrlSub1 alloc];
[vcs1 initWithNibName:nil bundle:nil];
[m_pParentView addSubview: vcs1.view];
ViewCtrlSub2 *vcs2 = [ViewCtrlSub2 alloc];
[vcs2 initWithNibName:nil@ bundle:nil];
[m_pParentView addSubview: vcs2.view];
[window addSubview: m_pParentView];
[m_pParentView bringSubviewToFront:vcs1.view];
// Override point for customization after application launch
[window makeKeyAndVisible];

The Utility template makes two content views that transition with the "flip" view animation. The root view is only used to position the Info style button on the main view. I.e. the root view itself is never visible. I didn't mean to imply that template provided the UI skeleton you were looking for, since you didn't describe what you're looking for. But the toggleView method in RootViewController.m is a good example of how to transition between two views without using a tab or nav view controller (since I assumed that was what you were trying to learn).
If you're still in the dark after studying and playing with the Utility template, the place to go is Chaper 6 of +Beginning iPhone Development: Exploring the iPhone SDK+ by Mark and LaMarche. In my opinion it's almost self destructive to try and learn iPhone programming without that book.
If you describe the view structure you want, I can give you some more hints, but you won't learn much by just pasting in a code sample.

Can we change color of comments in code?

Hi experts,
can any 1 say how to change color of text(comments) from default:blue to user specified.
Pls help me is it possible or not.
Cheers,
Siva

Hi,
It is not possible . It is standard fixed by SAP.
Regards,
Guru

Infos de "service" (affichage, dates concerts) étant en noir invisibles sur fond noir. Comment changer code source pour les rendre visible (p.ex. blancs)? merci

les infos dites de service p ex nombre de visites, dates de concerts etc sont paramétrées d'office en lettres noires, du coup, si le fond de la page du profile myspace est noir - ce qui est le cas de ma page - elles (ces infos) sont invisibles. Peut-on accéder au code source et paramétrer les lettres, les rendant p ex blanches? merci!

Do you see the text if you use Ctrl + A (Édition > Toutes sélectionner) ?
It is possible that the text is set to transparent.
Did you check the stylesheet CSS code for that text?
You can use the DOM Inspector to check the style rules.
* http://kb.mozillazine.org/DOM_Inspector
* https://developer.mozilla.org/En/DOM_Inspector

Commenting Out Library Code

When a Library item is inserted into an html document, it automatically adds some commenting out code


but still appears in Design View (which is expected). There are times when I don't want the actual Library item (a footer in this case) to be visible in Design View, and simply applying an html comment doesn't work (I assume because you are basically trying to double comment the code). So the question is: is there another way to temporarily hide a library item from appearing in Design View? The reason I'm asking this (and maybe there is another underlying issue) is because looking in Design View, the footer appears in the middle of hte page, but renders properly when previewing in either Live Mode or previewing in browser.
Design View: the red outline shows where the library item (footer) appears - in the middle of the design view area - worth noting, I work in Split view (with code on top, preview on bottom), so maybe that has something to do with not rendering items properly on screen?
Live View or Browser Preview:
I don't know if this is happening because of CSS styles of possibly some html code or maybe even an underlying issue somewhere else. This is more irritating than anything else. Does anyone have a clue what might be going on?
To add: the only way I am currently able to temporarily hide the footer library item is to open the library item, comment out that code, then update all pages (which is a pain for when I need to go back and forth)...

If this helps, I've uploaded what I think is enough to see what I'm facing.
As an FYI, your page content falls out of the box when end-users increase default text-size in their browsers (Firefox, View > Zoom > Zoom Text Only), hit Ctrl+++.
See screenshot below where I've highlighted dark text on dark background to be visible:
Height: value in pixels is a restriction in all browsers except IE. If needed to reveal a background image, use values in ems or the min-height property with Conditional Comments for pre-IE7 browsers.
CSS:
#homeContent {
    position: relative;
    width: 892px;
   min-height:400px;
Conditional Comment:

Nancy O.
Alt-Web Design & Publishing
Web | Graphics | Print | Media Specialists
http://alt-web.com/
http://twitter.com/altweb

How to comment code?

I know how to comment code but I was never really taught conventions for it. When should you comment something? What is the the standard way to comment a field? A method?
Asking because this trig solver i was quarter way into got so out of hand I got lost in my own code and had to stop.
As you can see no human being could possibly make anthing out of this without comments, as I was coding it I was fine. But when I woke up the next morning and started again I was lost.
package trianglesolver;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import javax.swing.GroupLayout;
import javax.swing.JButton;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JMenu;
import javax.swing.JMenuBar;
import javax.swing.JMenuItem;
import javax.swing.JPanel;
import javax.swing.JTextField;
public class Main {
    static boolean alreadyPressed = false;
    public static void main(String[] args) {
        JFrame mainFrame = new JFrame();
        mainFrame.setLocation(100, 100);
        mainFrame.setSize(480, 140);
        mainFrame.setTitle("Triangle Solver");
        mainFrame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
        mainFrame.setResizable(false);
        JPanel mainPanel = new JPanel();
        mainFrame.add(mainPanel);
        GroupLayout grouplayout = new GroupLayout(mainPanel);
        grouplayout.setAutoCreateGaps(true);
        grouplayout.setAutoCreateContainerGaps(true);
        JMenuBar menuBar = new JMenuBar();
        JMenu file = new JMenu("File");
        menuBar.add(file);
        mainFrame.setJMenuBar(menuBar);
        JMenuItem exit = new JMenuItem("Exit");
        file.add(exit);
        mainFrame.setVisible(true);
        exit.addActionListener(new ActionListener() {
            public void actionPerformed(ActionEvent e) {
                System.exit(0);
        JLabel angleA_Label = new JLabel("Angle A");
        final JTextField angleA = new JTextField("0", 8);
        JLabel angleB_Label = new JLabel("Angle B");
        final JTextField angleB = new JTextField("0", 8);
        JLabel angleC_Label = new JLabel("Angle C");
        final JTextField angleC = new JTextField("0", 8);
        JLabel sideA_Label = new JLabel("Side A");
        final JTextField sideA = new JTextField("0", 8);
        JLabel sideB_Label = new JLabel("Side B");
        final JTextField sideB = new JTextField("0", 8);
        JLabel sideC_Label = new JLabel("Side C");
        final JTextField sideC = new JTextField("0", 8);
        JButton solve = new JButton("Solve");
        solve.addActionListener(new ActionListener() {
            public void actionPerformed(ActionEvent e) throws NumberFormatException {
                if (alreadyPressed == false) {
                    double A = Double.parseDouble(angleA.getText());
                    double B = Double.parseDouble(angleB.getText());
                    double C = Double.parseDouble(angleC.getText());
                    double a = Double.parseDouble(sideA.getText());
                    double b = Double.parseDouble(sideB.getText());
                    double c = Double.parseDouble(sideC.getText());
                    if (a != 0 & b != 0 & c != 0) {
                        A = Math.acos((Math.pow(a, 2) - Math.pow(b, 2) - Math.pow(c, 2)) / (-2 * b * c));
                        B = Math.asin((b * Math.sin(A)) / a);
                        angleA.setText(String.valueOf(Math.toDegrees(A)));
                        angleB.setText(String.valueOf(Math.toDegrees(B)));
                        angleC.setText(String.valueOf(180 - Math.toDegrees(A) - Math.toDegrees(B)));
                        angleA.setCaretPosition(0);
                        angleB.setCaretPosition(0);
                        angleC.setCaretPosition(0);
                    } else if (a != 0 & b != 0 & C != 0) {
                        c = Math.sqrt(Math.pow(a, 2) + Math.pow(b, 2) - 2 * a * b * Math.cos(Math.toRadians(C)));
                        B = Math.asin((b * Math.sin(Math.toRadians(C))) / c);
                        sideC.setText(String.valueOf(c));
                        angleB.setText(String.valueOf(String.valueOf(Math.toDegrees(B))));
                        angleA.setText(String.valueOf(180 - Double.valueOf(angleB.getText()) - Double.valueOf(angleC.getText())));
                        sideC.setCaretPosition(0);
                        angleB.setCaretPosition(0);
                        angleA.setCaretPosition(0);
                    } else if (b != 0 & c != 0 & A != 0) {
                        a = Math.sqrt(Math.pow(b, 2) + Math.pow(c, 2) - 2 * b * c * Math.cos(Math.toRadians(A)));
                        B = Math.asin((a * Math.sin(Math.toRadians(A))) / a);
                        sideA.setText(String.valueOf(a));
                        angleB.setText(String.valueOf(String.valueOf(Math.toDegrees(B))));
                        angleC.setText(String.valueOf(180 - Math.toDegrees(B) - Double.valueOf(angleA.getText())));
                        sideA.setCaretPosition(0);
                        angleB.setCaretPosition(0);
                        angleC.setCaretPosition(0);
                    } else if (a != 0 & c != 0 & B != 0) {
                        b = Math.sqrt(Math.pow(a, 2) + Math.pow(c, 2) - 2 * a * c * Math.cos(Math.toRadians(B)));
                        C = Math.asin((c * Math.sin(Math.toRadians(B))) / b);
                        sideB.setText(String.valueOf(b));
                        angleC.setText(String.valueOf(String.valueOf(Math.toDegrees(C))));
                        angleA.setText(String.valueOf(180 - Double.valueOf(angleB.getText()) - Math.toDegrees(C)));
                        sideB.setCaretPosition(0);
                        angleC.setCaretPosition(0);
                        angleA.setCaretPosition(0);
                    alreadyPressed = true;
        grouplayout.setHorizontalGroup(
                grouplayout.createParallelGroup(GroupLayout.Alignment.LEADING).addComponent(angleA_Label).addComponent(angleA).addComponent(angleB_Label).addComponent(angleB).addComponent(angleC_Label).addComponent(angleC).addComponent(sideA_Label).addComponent(sideA).addComponent(sideB_Label).addComponent(sideB).addComponent(sideC_Label).addComponent(sideC).addComponent(solve));
}

James wrote:
I know how to comment code but I was never really taught conventions for it. When should you comment something? What is the the standard way to comment a field? A method? There really is no standard convention (if, by convention, you're referring to a set of rules used to determine when you should add a comment and when you should leave well enough alone). I try to document all public and protected methods, fields and constructors with JavaDoc documents. As for deciding when to add comments in other places my rule is this:
If the code is not "self documenting", and there is some sort of ambiguity, then I'll write a very brief description of what is going on.
If I am working on a large code base, and I make some sort of change, I will usually initial it, date it and provide a brief explanation of what I changed and why.
Aside from that - I just kinda wing it. Commenting is really a personal preference - it has to do with your own comfort level and the comfort level of your coworkers. A lot of shops have a set of guidelines in place for when/how you should comment your code. And by that I mean they usually have a minimal, "these things must be documented" and leave the rest to your discretion.
Asking because this trig solver i was quarter way into got so out of hand I got lost in my own code and had to stop.Looking at that tangled mess below, I'd say it's because you're code is a jumbled heap of grossness.
>
As you can see no human being could possibly make anthing out of this without comments,So rewrite it in a way that makes sense to someone. The pieces that can't be refactored for clarity will merit a brief comment or two.
as I was coding it I was fine. But when I woke up the next morning and started again I was lost.A good sign that you should have written your code more neatly and clearly.
grouplayout.createParallelGroup(GroupLayout.Alignment.LEADING).addComponent(angleA_Label).addComponent(angleA).addComponent(angleB_Label).addComponent(angleB).addComponent(angleC_Label).addComponent(angleC).addComponent(sideA_Label).addComponent(sideA).addComponent(sideB_Label).addComponent(sideB).addComponent(sideC_Label).addComponent(sideC).addComponent(solve));
Lines like that gem make me weep.

How to delete the commented out lines in PC editor of a SAP Script?

Hi Experts,
I hv lot of commentde out code in the PC editor of a my_SAP_Script.........so, wanna to delete all this commented out code, so, let me know that, Do we hv any option other than manual deletion.
Currently am doing it by,
keeping the line totally blank,
keeping the left small box, where we define paragraph formts,
going BACK,
save + activating,
now, those lines r disappearing!!
but, let me know, Is there any other MENU/push button optin to delete these lines?
replies appreciatesd,
thanq

[pc editor doc|http://help.sap.com/saphelp_nw2004s/helpdata/en/f4/b49f1b453611d189710000e8322d00/frameset.htm]

Comments on Code

Similar Messages

Maybe you are looking for